Jump to

• Request
• Response
• Examples

Update one customer program

patch

/fscmRestApi/resources/11.13.18.05/channelCustomerPrograms/{ProgramId}

Request

Path Parameters

• ProgramId(required): integer(int64)
  Value that uniquely identifies the customer program.

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

• additionalConditions: array Additional Conditions
  Title: Additional Conditions

  The Additional Conditions resource manages mandatory conditions for a program.
• attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• BeneficiaryType: string
  Maximum Length: 255

  Abbreviation that identifies the type of beneficiary.
• BeneficiaryTypeCode: string
  Maximum Length: 30

  Type of beneficiary used in the customer program. A list of accepted values is defined in the lookup type ORA_CJM_BENEFICIARY_TYPE.
• BeneficiaryValue: string
  Maximum Length: 255

  Abbreviation that identifies the beneficiary used in the customer program.
• BeneficiaryValueCode: number
  Name of the beneficiary used in the customer program.
• BusinessUnit: string
  Maximum Length: 255

  Name of the business unit.
• CommentsForApprovers: string
  Maximum Length: 4000

  Comments submitted to provide additional information to the approvers.
• Currency: string
  Maximum Length: 255

  Name of the currency used for the customer program.
• CurrencyCode: string
  Maximum Length: 15

  Abbreviation that identifies the currency used for the customer program.
• customers: array Customers
  Title: Customers

  The Customers resource manages rules for identifying eligible customers for a program.
• DateContextType: string
  Maximum Length: 255

  Name of the effective date type used for evaluating customer program eligibility. A list of accepted values is defined in the lookup type ORA_CJM_CUST_REBATE_DATE_QUAL.
• DateContextTypeCode: string
  Maximum Length: 30

  Default Value: FROM

  Abbreviation that identifies the effective date type used for evaluating customer program eligibility.
• Description: string
  Maximum Length: 1000

  Description of the customer program.
• DFF: array Channel Customer Programs Descriptive Flexfields
  Title: Channel Customer Programs Descriptive Flexfields

  The Descriptive Flexfields for Channel Customer Programs resource manages additional details for a program.
• EndDate: string (date)
  Date until when the program is applicable.
• EstimatedAmount: number
  Indicates the estimated amount for the program.
• notes: array Notes
  Title: Notes

  The Notes resource captures comments, information, or instructions for a program.
• Owner: string
  Maximum Length: 255

  Name of the person who owns the customer program. This attribute defaults to the name of the person who creates the program.
• OwnerId: integer (int64)
  Value that uniquely identifies the person who owns the customer program.
• productRules: array Product Rules
  Title: Product Rules

  The Product Rules resource manages rules for identifying eligible products for a program.
• ProgramName: string
  Title: Name

  Maximum Length: 240

  Name of the customer program.
• ProgramTemplate: string
  Maximum Length: 255

  Name of the predefined program template on which the customer program is based. A list of accepted values is defined in the lookup type ORA_CJM_PROGRAM_TYPE.
• ProgramType: string
  Maximum Length: 255

  Type of program on which the customer program is based.
• PromotionCode: string
  Maximum Length: 30

  Abbreviation that uniquely identifies the customer program.
• StartDate: string (date)
  Date from when the program is applicable.
• Status: string
  Maximum Length: 255

  Status of the customer program.
• StatusId: integer (int64)
  Value that uniquely identifies the status of the customer program.

{
    "type":"object",
    "properties":{
        "Owner":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the person who owns the customer program. This attribute defaults to the name of the person who creates the program.",
            "nullable":true
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"Description of the customer program.",
            "nullable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerPrograms-attachments-item-patch-request"
            }
        },
        "notes":{
            "title":"Notes",
            "type":"array",
            "description":"The Notes resource captures comments, information, or instructions for a program.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerPrograms-notes-item-patch-request"
            }
        },
        "BeneficiaryType":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the type of beneficiary.",
            "nullable":true
        },
        "BeneficiaryTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Type of beneficiary used in the customer program. A list of accepted values is defined in the lookup type ORA_CJM_BENEFICIARY_TYPE.",
            "nullable":true
        },
        "DFF":{
            "title":"Channel Customer Programs Descriptive Flexfields",
            "type":"array",
            "description":"The Descriptive Flexfields for Channel Customer Programs resource manages additional details for a program.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerPrograms-DFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "additionalConditions":{
            "title":"Additional Conditions",
            "type":"array",
            "description":"The Additional Conditions resource manages mandatory conditions for a program.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerPrograms-additionalConditions-item-patch-request"
            }
        },
        "EstimatedAmount":{
            "type":"number",
            "description":"Indicates the estimated amount for the program.",
            "nullable":true
        },
        "productRules":{
            "title":"Product Rules",
            "type":"array",
            "description":"The Product Rules resource manages rules for identifying eligible products for a program.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerPrograms-productRules-item-patch-request"
            }
        },
        "StartDate":{
            "type":"string",
            "description":"Date from when the program is applicable.",
            "format":"date",
            "nullable":false
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the currency used for the customer program.",
            "nullable":false
        },
        "BeneficiaryValueCode":{
            "type":"number",
            "description":"Name of the beneficiary used in the customer program.",
            "nullable":true
        },
        "OwnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the person who owns the customer program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DateContextType":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the effective date type used for evaluating customer program eligibility. A list of accepted values is defined in the lookup type ORA_CJM_CUST_REBATE_DATE_QUAL.",
            "nullable":true
        },
        "Currency":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the currency used for the customer program.",
            "nullable":true
        },
        "BeneficiaryValue":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the beneficiary used in the customer program.",
            "nullable":true
        },
        "ProgramType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of program on which the customer program is based.",
            "nullable":true
        },
        "customers":{
            "title":"Customers",
            "type":"array",
            "description":"The Customers resource manages rules for identifying eligible customers for a program.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerPrograms-customers-item-patch-request"
            }
        },
        "Status":{
            "maxLength":255,
            "type":"string",
            "description":"Status of the customer program.",
            "nullable":true
        },
        "PromotionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the customer program.",
            "nullable":true
        },
        "ProgramName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the customer program.",
            "nullable":false
        },
        "EndDate":{
            "type":"string",
            "description":"Date until when the program is applicable.",
            "format":"date",
            "nullable":true
        },
        "DateContextTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the effective date type used for evaluating customer program eligibility.",
            "nullable":false,
            "default":"FROM",
            "x-queryable":false
        },
        "BusinessUnit":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the business unit.",
            "nullable":true
        },
        "StatusId":{
            "type":"integer",
            "description":"Value that uniquely identifies the status of the customer program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ProgramTemplate":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the predefined program template on which the customer program is based. A list of accepted values is defined in the lookup type ORA_CJM_PROGRAM_TYPE.",
            "nullable":true
        },
        "CommentsForApprovers":{
            "maxLength":4000,
            "type":"string",
            "description":"Comments submitted to provide additional information to the approvers.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Additional Conditions

Type: array

Title: Additional Conditions

The Additional Conditions resource manages mandatory conditions for a program.

Show Source

• Array of: object schema

{
    "title":"Additional Conditions",
    "type":"array",
    "description":"The Additional Conditions resource manages mandatory conditions for a program.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerPrograms-additionalConditions-item-patch-request"
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object schema

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerPrograms-attachments-item-patch-request"
    }
}

Nested Schema : Customers

Type: array

Title: Customers

The Customers resource manages rules for identifying eligible customers for a program.

Show Source

• Array of: object schema

{
    "title":"Customers",
    "type":"array",
    "description":"The Customers resource manages rules for identifying eligible customers for a program.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerPrograms-customers-item-patch-request"
    }
}

Nested Schema : Channel Customer Programs Descriptive Flexfields

Type: array

Title: Channel Customer Programs Descriptive Flexfields

The Descriptive Flexfields for Channel Customer Programs resource manages additional details for a program.

Show Source

• Array of: object schema

{
    "title":"Channel Customer Programs Descriptive Flexfields",
    "type":"array",
    "description":"The Descriptive Flexfields for Channel Customer Programs resource manages additional details for a program.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerPrograms-DFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : Notes

Type: array

Title: Notes

The Notes resource captures comments, information, or instructions for a program.

Show Source

• Array of: object schema

{
    "title":"Notes",
    "type":"array",
    "description":"The Notes resource captures comments, information, or instructions for a program.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerPrograms-notes-item-patch-request"
    }
}

Nested Schema : Product Rules

Type: array

Title: Product Rules

The Product Rules resource manages rules for identifying eligible products for a program.

Show Source

• Array of: object schema

{
    "title":"Product Rules",
    "type":"array",
    "description":"The Product Rules resource manages rules for identifying eligible products for a program.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerPrograms-productRules-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• ComparisonOperator: string
  Maximum Length: 255

  Name of the comparison operator used in the additional condition. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.
• ComparisonOperatorCode: string
  Maximum Length: 30

  Abbreviation that identifies the comparison operator used in the additional condition.
• ProgramId: integer (int64)
  Value that uniquely identifies the customer program.
• QualifierType: string
  Maximum Length: 255

  Type of qualifier used to define eligibility of the customer program. A list of accepted values is defined in the lookup type ORA_CJM_CUST_REBATE_QUAL.
• QualifierTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of qualifier used to define customer program eligibility.
• QualifierValueCode: string
  Maximum Length: 240

  Abbreviation that identifies the qualifier used in customer program qualification.

{
    "type":"object",
    "properties":{
        "ComparisonOperator":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the comparison operator used in the additional condition.  A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.",
            "nullable":true,
            "x-queryable":false
        },
        "QualifierTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of qualifier used to define customer program eligibility.",
            "nullable":false
        },
        "QualifierValueCode":{
            "maxLength":240,
            "type":"string",
            "description":"Abbreviation that identifies the qualifier used in customer program qualification.",
            "nullable":false
        },
        "ProgramId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "QualifierType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of qualifier used to define eligibility of the customer program. A list of accepted values is defined in the lookup type ORA_CJM_CUST_REBATE_QUAL.",
            "nullable":true
        },
        "ComparisonOperatorCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the comparison operator used in the additional condition.",
            "nullable":false,
            "x-queryable":false
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  Document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  Contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  File name of the attachment.
• FileUrl: string
  Title: File Url

  URI of the file.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  Size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  Text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL of a web page type attachment.

{
    "type":"object",
    "properties":{
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• ComparisonOperator: string
  Maximum Length: 255

  Name of the comparison operator used in the customer. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.
• ComparisonOperatorCode: string
  Maximum Length: 30

  Abbreviation that identifies the comparison operator used in the customer.
• EndDate: string (date)
  Date when the customer is no longer applicable.
• ProgramId: integer (int64)
  Value that uniquely identifies the customer program.
• QualifierType: string
  Maximum Length: 255

  Type of qualifier used to define the eligibility of the customer program. A list of accepted values is defined in the lookup type ORA_CJM_CUST_REBATE_QUAL.
• QualifierTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of qualifier used to define the eligibility of the customer program.
• QualifierValueCode: string
  Maximum Length: 240

  Abbreviation that identifies the qualifier used in customer program qualification.
• StartDate: string (date)
  Date when the customer becomes applicable.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "type":"string",
            "description":"Date when the customer becomes applicable.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ComparisonOperator":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the comparison operator used in the customer.  A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.",
            "nullable":true,
            "x-queryable":false
        },
        "QualifierTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of qualifier used to define the eligibility of the customer program.",
            "nullable":false
        },
        "QualifierValueCode":{
            "maxLength":240,
            "type":"string",
            "description":"Abbreviation that identifies the qualifier used in customer program qualification.",
            "nullable":false
        },
        "ProgramId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "QualifierType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of qualifier used to define the eligibility of the customer program. A list of accepted values is defined in the lookup type ORA_CJM_CUST_REBATE_QUAL.",
            "nullable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the customer is no longer applicable.",
            "format":"date",
            "nullable":true
        },
        "ComparisonOperatorCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the comparison operator used in the customer.",
            "nullable":false
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Descriptive flexfield context name for customer program product rule.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Descriptive flexfield context display value for customer program product rule.
• ProgramHeaderId: integer (int64)
  Value that uniquely identifies the customer program.

{
    "type":"object",
    "properties":{
        "ProgramHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Descriptive flexfield context display value for customer program product rule.",
            "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":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield context name for customer program product rule.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• ContactRelationshipId: integer (int64)
  Title: Contact Relationship ID

  Relationship ID populated when the note is associated with a contact.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  Corporate currency code for extensibility.
• CreatorPartyId: integer (int64)
  Title: Creator Party ID

  Party ID for the note creator.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  Currency conversion rate type for extensibility.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  Currency code for extensibility.
• NoteTitle: string
  Title: Title

  Maximum Length: 500

  Title of the note entered by the user.
• NoteTxt: string (byte)
  Title: Note

  Column that stores the actual note text.
• NoteTypeCode: string
  Title: Type

  Maximum Length: 30

  Note type code for categorization of a note.
• SourceObjectId: string
  Title: Related Object

  Maximum Length: 64

  Unique identifier of the parent source object associated to the note.
• VisibilityCode: string
  Title: Private

  Maximum Length: 30

  Default Value: INTERNAL

  Attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"Currency code for extensibility.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SourceObjectId":{
            "title":"Related Object",
            "maxLength":64,
            "type":"string",
            "description":"Unique identifier of the parent source object associated to the note.",
            "nullable":false
        },
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"Party ID for the note creator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "NoteTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Note type code for categorization of a note.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceObjectCode"
                ]
            }
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"Currency conversion rate type for extensibility.",
            "nullable":true,
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"Corporate currency code for extensibility.",
            "nullable":true,
            "x-queryable":false
        },
        "VisibilityCode":{
            "title":"Private",
            "maxLength":30,
            "type":"string",
            "description":"Attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.",
            "nullable":false,
            "default":"INTERNAL",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ContactRelationshipId":{
            "title":"Contact Relationship ID",
            "type":"integer",
            "description":"Relationship ID populated when the note is associated with a contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "NoteTxt":{
            "title":"Note",
            "type":"string",
            "description":"Column that stores the actual note text.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            }
        },
        "NoteTitle":{
            "title":"Title",
            "maxLength":500,
            "type":"string",
            "description":"Title of the note entered by the user.",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• DFF: array Descriptive Flexfields for Product Rules
  Title: Descriptive Flexfields for Product Rules

  The Descriptive Flexfields for Product Rules resource manages additional details about a product rule of a program.
• DiscountAmount: number
  Value of the discount.
• DiscountType: string
  Maximum Length: 255

  Type of discount. A list of accepted values is defined in the lookup type ORA_CJM_LINE_DISCOUNT_TYPE.
• DiscountTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of discount.
• EndDate: string (date)
  Date when the product rule is no longer applicable.
• Item: string
  Maximum Length: 255

  Name of the item in the inventory.
• ItemDescription: string
  Maximum Length: 255

  Description of the item in the inventory.
• ItemId: string
  Maximum Length: 240

  Value that uniquely identifies the item in the inventory.
• ItemLevel: string
  Maximum Length: 255

  Level at which discounts are defined. Valid values include Item and All Items. A list of accepted values is defined in the lookup type ORA_CJM_ITEM_LEVEL.
• ItemLevelCode: string
  Maximum Length: 30

  Abbreviation that identifies the level at which discounts are defined.
• ProgramId: integer (int64)
  Value that uniquely identifies the customer program.
• StartDate: string (date)
  Date when the product rule becomes applicable.
• UnitOfMeasure: string
  Maximum Length: 255

  Unit of measure of the item for pricing.
• UOMCode: string
  Maximum Length: 30

  Abbreviation that identifies the unit of measure for pricing.

{
    "type":"object",
    "properties":{
        "DiscountTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of discount.",
            "nullable":false,
            "x-queryable":false
        },
        "UnitOfMeasure":{
            "maxLength":255,
            "type":"string",
            "description":"Unit of measure of the item for pricing.",
            "nullable":true,
            "x-queryable":false
        },
        "DFF":{
            "title":"Descriptive Flexfields for Product Rules",
            "type":"array",
            "description":"The Descriptive Flexfields for Product Rules resource manages additional details about a product rule of a program.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerPrograms-productRules-DFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "ProgramId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ItemId":{
            "maxLength":240,
            "type":"string",
            "description":"Value that uniquely identifies the item in the inventory.",
            "nullable":true
        },
        "ItemDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the item in the inventory.",
            "nullable":true,
            "x-queryable":false
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the product rule is no longer applicable.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "DiscountAmount":{
            "type":"number",
            "description":"Value of the discount.",
            "nullable":false,
            "x-queryable":false
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the product rule becomes applicable.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ItemLevel":{
            "maxLength":255,
            "type":"string",
            "description":"Level at which discounts are defined. Valid values include Item and All Items. A list of accepted values is defined in the lookup type ORA_CJM_ITEM_LEVEL.",
            "nullable":true
        },
        "Item":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the item in the inventory.",
            "nullable":true
        },
        "ItemLevelCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the level at which discounts are defined.",
            "nullable":false
        },
        "DiscountType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of discount. A list of accepted values is defined in the lookup type ORA_CJM_LINE_DISCOUNT_TYPE.",
            "nullable":true,
            "x-queryable":false
        },
        "UOMCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for pricing.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Descriptive Flexfields for Product Rules

Type: array

Title: Descriptive Flexfields for Product Rules

The Descriptive Flexfields for Product Rules resource manages additional details about a product rule of a program.

Show Source

• Array of: object schema

{
    "title":"Descriptive Flexfields for Product Rules",
    "type":"array",
    "description":"The Descriptive Flexfields for Product Rules resource manages additional details about a product rule of a program.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerPrograms-productRules-DFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Descriptive flexfield context name for customer program product rule.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Descriptive flexfield context display value for customer program product rule.
• ProgramLineId: integer
  Value that uniquely identifies the product rule.

{
    "type":"object",
    "properties":{
        "ProgramLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the product rule.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Descriptive flexfield context display value for customer program product rule.",
            "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":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield context name for customer program product rule.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "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(required):
  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(required):
  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 : channelCustomerPrograms-item-response

Type: object

Show Source

• AccountedEstimatedAmount: number
  Read Only: true

  Indicates the estimated amount in the functional currency.
• additionalConditions: array Additional Conditions
  Title: Additional Conditions

  The Additional Conditions resource manages mandatory conditions for a program.
• ApprovedDate: string (date)
  Read Only: true

  Date when the program is approved and moved to active status.
• attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• BeneficiaryAccountNumber: string
  Read Only: true

  Maximum Length: 255

  Number of the beneficiary bill-to customer account.
• BeneficiaryAddress: string
  Read Only: true

  Maximum Length: 255

  Primary bill-to address of the beneficiary customer.
• BeneficiaryCustomer: string
  Read Only: true

  Maximum Length: 255

  Name of the beneficiary customer.
• BeneficiaryType: string
  Maximum Length: 255

  Abbreviation that identifies the type of beneficiary.
• BeneficiaryTypeCode: string
  Maximum Length: 30

  Type of beneficiary used in the customer program. A list of accepted values is defined in the lookup type ORA_CJM_BENEFICIARY_TYPE.
• BeneficiaryValue: string
  Maximum Length: 255

  Abbreviation that identifies the beneficiary used in the customer program.
• BeneficiaryValueCode: number
  Name of the beneficiary used in the customer program.
• BusinessUnit: string
  Maximum Length: 255

  Name of the business unit.
• BusinessUnitId: integer (int64)
  Value that uniquely identifies the business unit.
• CommentsForApprovers: string
  Maximum Length: 4000

  Comments submitted to provide additional information to the approvers.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the record.
• Currency: string
  Maximum Length: 255

  Name of the currency used for the customer program.
• CurrencyCode: string
  Maximum Length: 15

  Abbreviation that identifies the currency used for the customer program.
• customers: array Customers
  Title: Customers

  The Customers resource manages rules for identifying eligible customers for a program.
• DateContextType: string
  Maximum Length: 255

  Name of the effective date type used for evaluating customer program eligibility. A list of accepted values is defined in the lookup type ORA_CJM_CUST_REBATE_DATE_QUAL.
• DateContextTypeCode: string
  Maximum Length: 30

  Default Value: FROM

  Abbreviation that identifies the effective date type used for evaluating customer program eligibility.
• Description: string
  Maximum Length: 1000

  Description of the customer program.
• DFF: array Channel Customer Programs Descriptive Flexfields
  Title: Channel Customer Programs Descriptive Flexfields

  The Descriptive Flexfields for Channel Customer Programs resource manages additional details for a program.
• EnableBeneficiaryFlag: string
  Read Only: true

  Maximum Length: 255

  Contains one of the following values: true or false. If true, then the beneficiary can be added to the channel program. If false, then the beneficiary can't be added to the channel programs. The value for this attribute is populated from the program type during program creation.
• EndDate: string (date)
  Date until when the program is applicable.
• EstimatedAmount: number
  Indicates the estimated amount for the program.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• notes: array Notes
  Title: Notes

  The Notes resource captures comments, information, or instructions for a program.
• Owner: string
  Maximum Length: 255

  Name of the person who owns the customer program. This attribute defaults to the name of the person who creates the program.
• OwnerId: integer (int64)
  Value that uniquely identifies the person who owns the customer program.
• productRules: array Product Rules
  Title: Product Rules

  The Product Rules resource manages rules for identifying eligible products for a program.
• ProgramId: integer (int64)
  Value that uniquely identifies the customer program.
• ProgramName: string
  Title: Name

  Maximum Length: 240

  Name of the customer program.
• ProgramTemplate: string
  Maximum Length: 255

  Name of the predefined program template on which the customer program is based. A list of accepted values is defined in the lookup type ORA_CJM_PROGRAM_TYPE.
• ProgramTemplateCode: string
  Maximum Length: 30

  Abbreviation that identifies the predefined program template on which the customer program is based.
• ProgramType: string
  Maximum Length: 255

  Type of program on which the customer program is based.
• ProgramTypeId: integer (int64)
  Value that uniquely identifies the type of program on which the customer program is based.
• PromotionCode: string
  Maximum Length: 30

  Abbreviation that uniquely identifies the customer program.
• RejectedDate: string (date)
  Read Only: true

  Date when the program is rejected.
• StartDate: string (date)
  Date from when the program is applicable.
• Status: string
  Maximum Length: 255

  Status of the customer program.
• StatusId: integer (int64)
  Value that uniquely identifies the status of the customer program.
• SubmittedBy: string
  Read Only: true

  Maximum Length: 255

  Name that identifies the user who submitted the program for approval.
• SubmittedDate: string (date)
  Read Only: true

  Date when the program is submitted.
• SystemStatus: string
  Read Only: true

  Maximum Length: 255

  System status of the customer program.
• SystemStatusCode: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the system status of the customer program.

{
    "type":"object",
    "properties":{
        "RejectedDate":{
            "type":"string",
            "description":"Date when the program is rejected.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Owner":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the person who owns the customer program. This attribute defaults to the name of the person who creates the program.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"Description of the customer program.",
            "nullable":true,
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerPrograms-attachments-item-response"
            }
        },
        "notes":{
            "title":"Notes",
            "type":"array",
            "description":"The Notes resource captures comments, information, or instructions for a program.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerPrograms-notes-item-response"
            }
        },
        "BeneficiaryType":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the type of beneficiary.",
            "nullable":true,
            "x-queryable":true
        },
        "BeneficiaryTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Type of beneficiary used in the customer program. A list of accepted values is defined in the lookup type ORA_CJM_BENEFICIARY_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "DFF":{
            "title":"Channel Customer Programs Descriptive Flexfields",
            "type":"array",
            "description":"The Descriptive Flexfields for Channel Customer Programs resource manages additional details for a program.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerPrograms-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "additionalConditions":{
            "title":"Additional Conditions",
            "type":"array",
            "description":"The Additional Conditions resource manages mandatory conditions for a program.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerPrograms-additionalConditions-item-response"
            }
        },
        "EstimatedAmount":{
            "type":"number",
            "description":"Indicates the estimated amount for the program.",
            "nullable":true,
            "x-queryable":true
        },
        "productRules":{
            "title":"Product Rules",
            "type":"array",
            "description":"The Product Rules resource manages rules for identifying eligible products for a program.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerPrograms-productRules-item-response"
            }
        },
        "SubmittedDate":{
            "type":"string",
            "description":"Date when the program is submitted.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date from when the program is applicable.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the currency used for the customer program.",
            "nullable":false,
            "x-queryable":true
        },
        "BeneficiaryValueCode":{
            "type":"number",
            "description":"Name of the beneficiary used in the customer program.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the person who owns the customer program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DateContextType":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the effective date type used for evaluating customer program eligibility. A list of accepted values is defined in the lookup type ORA_CJM_CUST_REBATE_DATE_QUAL.",
            "nullable":true,
            "x-queryable":true
        },
        "Currency":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the currency used for the customer program.",
            "nullable":true,
            "x-queryable":true
        },
        "BeneficiaryValue":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the beneficiary used in the customer program.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProgramType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of program on which the customer program is based.",
            "nullable":true,
            "x-queryable":true
        },
        "customers":{
            "title":"Customers",
            "type":"array",
            "description":"The Customers resource manages rules for identifying eligible customers for a program.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerPrograms-customers-item-response"
            }
        },
        "SystemStatus":{
            "maxLength":255,
            "type":"string",
            "description":"System status of the customer program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":255,
            "type":"string",
            "description":"Status of the customer program.",
            "nullable":true,
            "x-queryable":true
        },
        "BeneficiaryCustomer":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the beneficiary customer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApprovedDate":{
            "type":"string",
            "description":"Date when the program is approved and moved to active status.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SystemStatusCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the system status of the customer program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramTemplateCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the predefined program template on which the customer program is based.",
            "nullable":false,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PromotionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the customer program.",
            "nullable":true,
            "x-queryable":true
        },
        "BeneficiaryAddress":{
            "maxLength":255,
            "type":"string",
            "description":"Primary bill-to address of the beneficiary customer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountedEstimatedAmount":{
            "type":"number",
            "description":"Indicates the estimated amount in the functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmittedBy":{
            "maxLength":255,
            "type":"string",
            "description":"Name that identifies the user who submitted the program for approval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProgramName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the customer program.",
            "nullable":false,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date until when the program is applicable.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "BeneficiaryAccountNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number of the beneficiary bill-to customer account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the type of program on which the customer program is based.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DateContextTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the effective date type used for evaluating customer program eligibility.",
            "nullable":false,
            "default":"FROM",
            "x-queryable":false
        },
        "BusinessUnit":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the business unit.",
            "nullable":true,
            "x-queryable":true
        },
        "EnableBeneficiaryFlag":{
            "maxLength":255,
            "type":"string",
            "description":"Contains one of the following values: true or false. If true, then the beneficiary can be added to the channel program. If false, then the beneficiary can't be added to the channel programs. The value for this attribute is populated from the program type during program creation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusId":{
            "type":"integer",
            "description":"Value that uniquely identifies the status of the customer program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProgramTemplate":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the predefined program template on which the customer program is based. A list of accepted values is defined in the lookup type ORA_CJM_PROGRAM_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CommentsForApprovers":{
            "maxLength":4000,
            "type":"string",
            "description":"Comments submitted to provide additional information to the approvers.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Additional Conditions

Type: array

Title: Additional Conditions

The Additional Conditions resource manages mandatory conditions for a program.

Show Source

• Array of: object channelCustomerPrograms-additionalConditions-item-response

{
    "title":"Additional Conditions",
    "type":"array",
    "description":"The Additional Conditions resource manages mandatory conditions for a program.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerPrograms-additionalConditions-item-response"
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object channelCustomerPrograms-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerPrograms-attachments-item-response"
    }
}

Nested Schema : Customers

Type: array

Title: Customers

The Customers resource manages rules for identifying eligible customers for a program.

Show Source

• Array of: object channelCustomerPrograms-customers-item-response

{
    "title":"Customers",
    "type":"array",
    "description":"The Customers resource manages rules for identifying eligible customers for a program.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerPrograms-customers-item-response"
    }
}

Nested Schema : Channel Customer Programs Descriptive Flexfields

Type: array

Title: Channel Customer Programs Descriptive Flexfields

The Descriptive Flexfields for Channel Customer Programs resource manages additional details for a program.

Show Source

• Array of: object channelCustomerPrograms-DFF-item-response

{
    "title":"Channel Customer Programs Descriptive Flexfields",
    "type":"array",
    "description":"The Descriptive Flexfields for Channel Customer Programs resource manages additional details for a program.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerPrograms-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 : Notes

Type: array

Title: Notes

The Notes resource captures comments, information, or instructions for a program.

Show Source

• Array of: object channelCustomerPrograms-notes-item-response

{
    "title":"Notes",
    "type":"array",
    "description":"The Notes resource captures comments, information, or instructions for a program.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerPrograms-notes-item-response"
    }
}

Nested Schema : Product Rules

Type: array

Title: Product Rules

The Product Rules resource manages rules for identifying eligible products for a program.

Show Source

• Array of: object channelCustomerPrograms-productRules-item-response

{
    "title":"Product Rules",
    "type":"array",
    "description":"The Product Rules resource manages rules for identifying eligible products for a program.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerPrograms-productRules-item-response"
    }
}

Nested Schema : channelCustomerPrograms-additionalConditions-item-response

Type: object

Show Source

• AccountNumber: string
  Read Only: true

  Maximum Length: 255

  Number of the bill-to customer account.
• Address: string
  Read Only: true

  Maximum Length: 255

  Primary bill-to address for the customer or the address of the bill-to customer account site or the ship-to site.
• ComparisonOperator: string
  Maximum Length: 255

  Name of the comparison operator used in the additional condition. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.
• ComparisonOperatorCode: string
  Maximum Length: 30

  Abbreviation that identifies the comparison operator used in the additional condition.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the record.
• Customer: string
  Read Only: true

  Maximum Length: 255

  Name of the customer.
• CustomQualifierFlag: boolean
  Read Only: true

  Contains one of the following values: true or false. If true, then it's a custom qualifier. If false, then it isn't a custom qualifier. The default value for this attribute is false.
• DomainDataTypeCode: string
  Read Only: true

  Maximum Length: 255

  Type of dimension data. Valid values include text, number, date, and time stamp. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DATA_TYPES.
• DomainLookupTypeCode: string
  Read Only: true

  Maximum Length: 255

  Lookup type code for the dimension of the lookup domain type.
• DomainTypeCode: string
  Read Only: true

  Maximum Length: 255

  Type of domain. Valid values include lookup, view object query, and custom. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DOMAIN_TYPES.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MatrixDimensionId: integer
  Read Only: true

  Value that uniquely identifies the dimension.
• ProgramId: integer (int64)
  Value that uniquely identifies the customer program.
• QualifierId: integer (int64)
  Read Only: true

  Value that uniquely identifies the additional condition.
• QualifierNumberValueCode: integer
  Read Only: true

  Value of the numeric qualifier used in customer program qualification.
• QualifierType: string
  Maximum Length: 255

  Type of qualifier used to define eligibility of the customer program. A list of accepted values is defined in the lookup type ORA_CJM_CUST_REBATE_QUAL.
• QualifierTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of qualifier used to define customer program eligibility.
• QualifierValue: string
  Read Only: true

  Maximum Length: 255

  Name of the qualifier used in customer program qualification.
• QualifierValueCode: string
  Maximum Length: 240

  Abbreviation that identifies the qualifier used in customer program qualification.
• Site: string
  Read Only: true

  Maximum Length: 255

  Name of the bill-to customer account site or the ship-to site.

{
    "type":"object",
    "properties":{
        "Site":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the bill-to customer account site or the ship-to site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ComparisonOperator":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the comparison operator used in the additional condition.  A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Address":{
            "maxLength":255,
            "type":"string",
            "description":"Primary bill-to address for the customer or the address of the bill-to customer account site or the ship-to site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Customer":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the customer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DomainTypeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Type of domain. Valid values include lookup, view object query, and custom. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DOMAIN_TYPES.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QualifierValue":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the qualifier used in customer program qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QualifierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the additional condition.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QualifierValueCode":{
            "maxLength":240,
            "type":"string",
            "description":"Abbreviation that identifies the qualifier used in customer program qualification.",
            "nullable":false,
            "x-queryable":true
        },
        "QualifierNumberValueCode":{
            "type":"integer",
            "description":"Value of the numeric qualifier used in customer program qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QualifierType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of qualifier used to define eligibility of the customer program. A list of accepted values is defined in the lookup type ORA_CJM_CUST_REBATE_QUAL.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number of the bill-to customer account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MatrixDimensionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DomainDataTypeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Type of dimension data. Valid values include text, number, date, and time stamp. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DATA_TYPES.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComparisonOperatorCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the comparison operator used in the additional condition.",
            "nullable":false,
            "x-queryable":false
        },
        "QualifierTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of qualifier used to define customer program eligibility.",
            "nullable":false,
            "x-queryable":true
        },
        "DomainLookupTypeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Lookup type code for the dimension of the lookup domain type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CustomQualifierFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then it's a custom qualifier. If false, then it isn't a custom qualifier. The default value for this attribute is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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 : 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 : channelCustomerPrograms-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  User who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  User name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  Document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  Contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  File name of the attachment.
• FileUrl: string
  Title: File Url

  URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  Base64-encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  User who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  User name who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  Size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  Text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  Login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"Base64-encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"User name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"User who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"Login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"User name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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 : channelCustomerPrograms-customers-item-response

Type: object

Show Source

• AccountNumber: string
  Read Only: true

  Maximum Length: 255

  Number of the bill-to customer account.
• Address: string
  Read Only: true

  Maximum Length: 255

  Primary bill-to address for the customer or the address of the bill-to customer account site or the ship-to site.
• ChildRuleNumber: integer (int32)
  Number that identifies the trailing component of the display line number. The display line number is a concatenation of the rule number and the child rule number separated by a period. For example, if the display line number is 5.2, then the rule number is 5 and the child rule number is 2. Validation: It must be an integer >= 0. It can't have a duplicate display line number.
• ComparisonOperator: string
  Maximum Length: 255

  Name of the comparison operator used in the customer. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.
• ComparisonOperatorCode: string
  Maximum Length: 30

  Abbreviation that identifies the comparison operator used in the customer.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the record.
• Customer: string
  Read Only: true

  Maximum Length: 255

  Name of the customer.
• CustomQualifierFlag: boolean
  Read Only: true

  Contains one of the following values: true or false. If true, then it's a custom qualifier. If false, then it isn't a custom qualifier. The default value for this attribute is false.
• DomainDataTypeCode: string
  Read Only: true

  Maximum Length: 255

  Type of dimension data. Valid values include text, number, date, and time stamp. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DATA_TYPES.
• DomainLookupTypeCode: string
  Read Only: true

  Maximum Length: 255

  Lookup type code for the dimension of the lookup domain type.
• DomainTypeCode: string
  Read Only: true

  Maximum Length: 255

  Type of domain. Valid values include lookup, view object query, and custom. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DOMAIN_TYPES.
• EndDate: string (date)
  Date when the customer is no longer applicable.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MatrixDimensionId: integer
  Read Only: true

  Value that uniquely identifies the dimension.
• ParentRuleId: integer (int64)
  Value that identifies the parent customer.
• ProgramId: integer (int64)
  Value that uniquely identifies the customer program.
• QualifierNumberValueCode: integer
  Read Only: true

  Value of the numeric qualifier used in customer program qualification.
• QualifierType: string
  Maximum Length: 255

  Type of qualifier used to define the eligibility of the customer program. A list of accepted values is defined in the lookup type ORA_CJM_CUST_REBATE_QUAL.
• QualifierTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of qualifier used to define the eligibility of the customer program.
• QualifierValue: string
  Read Only: true

  Maximum Length: 255

  Name of the qualifier used in customer program qualification.
• QualifierValueCode: string
  Maximum Length: 240

  Abbreviation that identifies the qualifier used in customer program qualification.
• RuleId: integer (int64)
  Read Only: true

  Value that uniquely identifies the customer. It's a primary key that the application generates when it creates the customer.
• RuleNumber: integer (int32)
  Number that identifies the leading component of the display line number. The display line number is a concatenation of the rule number and the child rule number separated by a period. For example, if the display line number is 3.1, then the rule number is 3 and the child rule number is 1. Validation: It must be an integer > 0. Cannot have duplicate display line number.
• Site: string
  Read Only: true

  Maximum Length: 255

  Name of the bill-to customer account site or the ship-to site.
• StartDate: string (date)
  Date when the customer becomes applicable.

{
    "type":"object",
    "properties":{
        "Site":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the bill-to customer account site or the ship-to site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ComparisonOperator":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the comparison operator used in the customer.  A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.",
            "nullable":true,
            "x-queryable":false
        },
        "Address":{
            "maxLength":255,
            "type":"string",
            "description":"Primary bill-to address for the customer or the address of the bill-to customer account site or the ship-to site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Customer":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the customer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DomainTypeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Type of domain. Valid values include lookup, view object query, and custom. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DOMAIN_TYPES.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer. It's a primary key that the application generates when it creates the customer.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QualifierValueCode":{
            "maxLength":240,
            "type":"string",
            "description":"Abbreviation that identifies the qualifier used in customer program qualification.",
            "nullable":false,
            "x-queryable":true
        },
        "MatrixDimensionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the customer becomes applicable.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "QualifierTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of qualifier used to define the eligibility of the customer program.",
            "nullable":false,
            "x-queryable":true
        },
        "DomainLookupTypeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Lookup type code for the dimension of the lookup domain type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CustomQualifierFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then it's a custom qualifier. If false, then it isn't a custom qualifier. The default value for this attribute is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleNumber":{
            "type":"integer",
            "description":"Number that identifies the leading component of the display line number. The display line number is a concatenation of the rule number and the child rule number separated by a period. For example, if the display line number is 3.1, then the rule number is 3 and the child rule number is 1.\nValidation: It must be an integer > 0. Cannot have duplicate display line number.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":4
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentRuleId":{
            "type":"integer",
            "description":"Value that identifies the parent customer.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QualifierValue":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the qualifier used in customer program qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChildRuleNumber":{
            "type":"integer",
            "description":"Number that identifies the trailing component of the display line number. The display line number is a concatenation of the rule number and the child rule number separated by a period. For example, if the display line number is 5.2, then the rule number is 5 and the child rule number is 2. \nValidation: It must be an integer >= 0.  It can't have a duplicate display line number.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":4
            },
            "x-queryable":true
        },
        "QualifierNumberValueCode":{
            "type":"integer",
            "description":"Value of the numeric qualifier used in customer program qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QualifierType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of qualifier used to define the eligibility of the customer program. A list of accepted values is defined in the lookup type ORA_CJM_CUST_REBATE_QUAL.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the customer is no longer applicable.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AccountNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number of the bill-to customer account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DomainDataTypeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Type of dimension data. Valid values include text, number, date, and time stamp. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DATA_TYPES.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComparisonOperatorCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the comparison operator used in the customer.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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 : channelCustomerPrograms-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Descriptive flexfield context name for customer program product rule.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Descriptive flexfield context display value for customer program product rule.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProgramHeaderId: integer (int64)
  Value that uniquely identifies the customer program.

{
    "type":"object",
    "properties":{
        "ProgramHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Descriptive flexfield context display value for customer program product rule.",
            "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":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield context name for customer program product rule.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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 : channelCustomerPrograms-notes-item-response

Type: object

Show Source

• ContactRelationshipId: integer (int64)
  Title: Contact Relationship ID

  Relationship ID populated when the note is associated with a contact.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  Corporate currency code for extensibility.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the record was created.
• CreatorPartyId: integer (int64)
  Title: Creator Party ID

  Party ID for the note creator.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  Currency conversion rate type for extensibility.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  Currency code for extensibility.
• DeleteFlag: boolean
  Title: Delete Indicator

  Read Only: true

  Indicates whether the user has access to delete the note.
• EmailAddress: string
  Title: Primary Email

  Read Only: true

  Maximum Length: 320

  Email address of the user who created the note.
• FormattedAddress: string
  Title: Primary Address

  Read Only: true

  Address of the user who created the note.
• FormattedPhoneNumber: string
  Title: Primary Phone

  Read Only: true

  Phone number of the user who created the note.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  Login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NoteId: integer (int64)
  Title: Note ID

  Read Only: true

  Value that uniquely identifies the note. This is the primary key of the notes table.
• NoteNumber: string
  Maximum Length: 30

  Alternate unique identifier of the note. A user key that's system generated or from an external system.
• NoteTitle: string
  Title: Title

  Maximum Length: 500

  Title of the note entered by the user.
• NoteTxt: string (byte)
  Title: Note

  Column that stores the actual note text.
• NoteTypeCode: string
  Title: Type

  Maximum Length: 30

  Note type code for categorization of a note.
• ParentNoteId: integer (int64)
  Title: Parent Note ID

  Unique identifier of the parent source object associated with the note.
• PartyId: integer (int64)
  Title: Party ID

  Read Only: true

  Unique identifier of the party.
• PartyName: string
  Title: Author

  Read Only: true

  Maximum Length: 360

  Name of the party.
• SourceObjectCode: string
  Title: Related Object Type

  Maximum Length: 30

  Source object code for the source object as defined in OBJECTS Metadata.
• SourceObjectId: string
  Title: Related Object

  Maximum Length: 64

  Unique identifier of the parent source object associated to the note.
• UpdateFlag: boolean
  Title: Update Indicator

  Read Only: true

  Indicates whether the user can update the note.
• VisibilityCode: string
  Title: Private

  Maximum Length: 30

  Default Value: INTERNAL

  Attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Author",
            "maxLength":360,
            "type":"string",
            "description":"Name of the party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"Currency conversion rate type for extensibility.",
            "nullable":true,
            "x-queryable":false
        },
        "VisibilityCode":{
            "title":"Private",
            "maxLength":30,
            "type":"string",
            "description":"Attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.",
            "nullable":false,
            "default":"INTERNAL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactRelationshipId":{
            "title":"Contact Relationship ID",
            "type":"integer",
            "description":"Relationship ID populated when the note is associated with a contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"Currency code for extensibility.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UpdateFlag":{
            "title":"Update Indicator",
            "type":"boolean",
            "description":"Indicates whether the user can update the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Alternate unique identifier of the note. A user key that's system generated or from an external system.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Related Object Type",
            "maxLength":30,
            "type":"string",
            "description":"Source object code for the source object as defined in OBJECTS Metadata.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Primary Phone",
            "type":"string",
            "description":"Phone number of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"Corporate currency code for extensibility.",
            "nullable":true,
            "x-queryable":false
        },
        "NoteTxt":{
            "title":"Note",
            "type":"string",
            "description":"Column that stores the actual note text.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            },
            "x-queryable":true
        },
        "NoteTitle":{
            "title":"Title",
            "maxLength":500,
            "type":"string",
            "description":"Title of the note entered by the user.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteId":{
            "title":"Note ID",
            "type":"integer",
            "description":"Value that uniquely identifies the note. This is the primary key of the notes table.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"Party ID for the note creator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Primary Address",
            "type":"string",
            "description":"Address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Note type code for categorization of a note.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceObjectCode"
                ]
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Primary Email",
            "maxLength":320,
            "type":"string",
            "description":"Email address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete Indicator",
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceObjectId":{
            "title":"Related Object",
            "maxLength":64,
            "type":"string",
            "description":"Unique identifier of the parent source object associated to the note.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"Unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentNoteId":{
            "title":"Parent Note ID",
            "type":"integer",
            "description":"Unique identifier of the parent source object associated with the note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"Login of the user who last updated the record.",
            "nullable":true,
            "readOnly":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 : channelCustomerPrograms-productRules-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the record.
• DFF: array Descriptive Flexfields for Product Rules
  Title: Descriptive Flexfields for Product Rules

  The Descriptive Flexfields for Product Rules resource manages additional details about a product rule of a program.
• DiscountAmount: number
  Value of the discount.
• DiscountType: string
  Maximum Length: 255

  Type of discount. A list of accepted values is defined in the lookup type ORA_CJM_LINE_DISCOUNT_TYPE.
• DiscountTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of discount.
• EndDate: string (date)
  Date when the product rule is no longer applicable.
• Item: string
  Maximum Length: 255

  Name of the item in the inventory.
• ItemDescription: string
  Maximum Length: 255

  Description of the item in the inventory.
• ItemId: string
  Maximum Length: 240

  Value that uniquely identifies the item in the inventory.
• ItemLevel: string
  Maximum Length: 255

  Level at which discounts are defined. Valid values include Item and All Items. A list of accepted values is defined in the lookup type ORA_CJM_ITEM_LEVEL.
• ItemLevelCode: string
  Maximum Length: 30

  Abbreviation that identifies the level at which discounts are defined.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProgramId: integer (int64)
  Value that uniquely identifies the customer program.
• ProgramLineId: integer
  Value that uniquely identifies the product rule. It is a primary key that the application generates when it creates the product rule.
• StartDate: string (date)
  Date when the product rule becomes applicable.
• UnitOfMeasure: string
  Maximum Length: 255

  Unit of measure of the item for pricing.
• UOMCode: string
  Maximum Length: 30

  Abbreviation that identifies the unit of measure for pricing.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DiscountTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of discount.",
            "nullable":false,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "maxLength":255,
            "type":"string",
            "description":"Unit of measure of the item for pricing.",
            "nullable":true,
            "x-queryable":false
        },
        "DFF":{
            "title":"Descriptive Flexfields for Product Rules",
            "type":"array",
            "description":"The Descriptive Flexfields for Product Rules resource manages additional details about a product rule of a program.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerPrograms-productRules-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "ProgramId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemId":{
            "maxLength":240,
            "type":"string",
            "description":"Value that uniquely identifies the item in the inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the item in the inventory.",
            "nullable":true,
            "x-queryable":false
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the product rule is no longer applicable.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "DiscountAmount":{
            "type":"number",
            "description":"Value of the discount.",
            "nullable":false,
            "x-queryable":false
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the product rule becomes applicable.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ItemLevel":{
            "maxLength":255,
            "type":"string",
            "description":"Level at which discounts are defined. Valid values include Item and All Items. A list of accepted values is defined in the lookup type ORA_CJM_ITEM_LEVEL.",
            "nullable":true,
            "x-queryable":true
        },
        "Item":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the item in the inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the product rule. It is a primary key that the application generates when it creates the product rule.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemLevelCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the level at which discounts are defined.",
            "nullable":false,
            "x-queryable":true
        },
        "DiscountType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of discount. A list of accepted values is defined in the lookup type ORA_CJM_LINE_DISCOUNT_TYPE.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UOMCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for pricing.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Descriptive Flexfields for Product Rules

Type: array

Title: Descriptive Flexfields for Product Rules

The Descriptive Flexfields for Product Rules resource manages additional details about a product rule of a program.

Show Source

• Array of: object channelCustomerPrograms-productRules-DFF-item-response

{
    "title":"Descriptive Flexfields for Product Rules",
    "type":"array",
    "description":"The Descriptive Flexfields for Product Rules resource manages additional details about a product rule of a program.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerPrograms-productRules-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 : channelCustomerPrograms-productRules-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Descriptive flexfield context name for customer program product rule.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Descriptive flexfield context display value for customer program product rule.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProgramLineId: integer
  Value that uniquely identifies the product rule.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProgramLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the product rule.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Descriptive flexfield context display value for customer program product rule.",
            "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":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield context name for customer program product rule.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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

DFF

Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerPrograms/{ProgramId}/child/DFF

Parameters:

• ProgramId: $request.path.ProgramId

The Descriptive Flexfields for Channel Customer Programs resource manages additional details for a program.

additionalConditions

Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerPrograms/{ProgramId}/child/additionalConditions

Parameters:

• ProgramId: $request.path.ProgramId

The Additional Conditions resource manages mandatory conditions for a program.

attachments

Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerPrograms/{ProgramId}/child/attachments

Parameters:

• ProgramId: $request.path.ProgramId

The attachments resource is used to view, create, and update attachments.

customers

Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerPrograms/{ProgramId}/child/customers

Parameters:

• ProgramId: $request.path.ProgramId

The Customers resource manages rules for identifying eligible customers for a program.

notes

Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerPrograms/{ProgramId}/child/notes

Parameters:

• ProgramId: $request.path.ProgramId

The Notes resource captures comments, information, or instructions for a program.

productRules

Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerPrograms/{ProgramId}/child/productRules

Parameters:

• ProgramId: $request.path.ProgramId

The Product Rules resource manages rules for identifying eligible products for a program.

submit

Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerPrograms/{ProgramId}/action/submit

Parameters:

• ProgramId: $request.path.ProgramId

Back to Top

Examples

This example describes how to update one customer program.

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/channelCustomerPrograms/ProgramId"

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.

{
     "Status": "Active"
}

Example Response Body

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

{
    "ProgramId": 300100574861411,
    "ProgramType": "CRTP2",
    "ProgramTypeId": 300100571136403,
    "ProgramTemplate": "Customer Promotion",
    "ProgramTemplateCode": "CUSTOMER_REBATE",
    "BusinessUnit": "Vision Operations",
    "BusinessUnitId": 204,
    "ProgramName": "Spring Special",
    "PromotionCode": "CR42005",
    "Owner": "TAX_ACCT_OPERATIONS",
    "OwnerId": 185,
    "Status": "Active",
    "StatusId": 100100144204820,
    "SystemStatus": "Active",
    "SystemStatusCode": "ACTIVE",
    "DateContextType": "Invoice Date",
    "DateContextTypeCode": "SALES_INVOICE_DATE",
    "StartDate": "2022-02-01",
    "EndDate": "2023-05-31",
    "Currency": "US Dollar",
    "CurrencyCode": "USD",
    "Description": null,
    "BeneficiaryType": null,
    "BeneficiaryTypeCode": null,
    "BeneficiaryValue": null,
    "BeneficiaryValueCode": null,
    "BeneficiaryCustomer": null,
    "BeneficiaryAccountNumber": null,
    "BeneficiaryAddress": null,
    "EnableBeneficiaryFlag": null,
    "CreatedBy": "channel_user",
    "CreationDate": "2023-02-03T13:03:01+00:00",
    "LastUpdatedBy": "channel_user",
    "LastUpdateDate": "2023-02-03T13:17:43.040+00:00",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100574861411",
            "name": "channelCustomerPrograms",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100574861411",
            "name": "channelCustomerPrograms",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100574861411/child/DFF",
            "name": "DFF",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100574861411/child/additionalConditions",
            "name": "additionalConditions",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100574861411/child/attachments",
            "name": "attachments",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100574861411/child/customers",
            "name": "customers",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerPrograms/300100574861411/child/productRules",
            "name": "productRules",
            "kind": "collection"
        }
    ]
}

Back to Top