Jump to

• Request
• Response
• Examples

Get one program

get

/fscmRestApi/resources/11.13.18.05/channelPrograms/{ProgramId}

Request

Path Parameters

• ProgramId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : channelPrograms-item-response

Type: object

Show Source

• alternateSupplierSites: array Alternate Supplier Sites
  Title: Alternate Supplier Sites

  The Alternate Supplier Sites resource manages alternate supplier sites of a supplier rebate program.
• ApplyManuallyToOrderFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If it's true, then the channel program isn't automatically applied on sales orders even if the eligibility criteria is met. If it's false, then the channel program is automatically applied on sales orders upon eligibility evaluation. The value is defaulted from program type.
• attachments: array Attachments
  Title: Attachments

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

  Available amount in the channel program.
• BusinessUnit: string
  Channel Programs
• BusinessUnitId: integer (int64)
  Channel Programs
• CalculationMethod: string
  Method used for calculating accruals in the channel program. A list of accepted values is defined in the lookup type ORA_CJM_TIER_CALC_METHOD.
• CalculationMethodCode: string
  Maximum Length: 30

  Abbreviation that identifies the calculation method used for calculating accruals in the channel program.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Channel Programs
• Currency: string
  Name of the currency used for the channel program.
• CurrencyCode: string
  Maximum Length: 15

  Abbreviation that identifies the currency used for the channel program.
• Description: string
  Maximum Length: 1000

  Description of the channel program.
• DFF: array DFF
• EarnedAmount: number
  Read Only: true

  Earned amount in the channel program.
• EffectiveDateType: string
  Maximum Length: 255

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

  Default Value: FROM

  Abbreviation that identifies the sales order date type used for evaluating channel program eligibility. A list of accepted values is defined in the lookup type ORA_CJM_PRICING_APP_DATE_TYPE.
• FromDate: string (date)
  Channel Programs
• InitiatedBy: string
  Value that identifies if the program was created by the supplier contact or the internal distributor user.
• InitiatedByCode: string
  Maximum Length: 20

  Abbreviation that identifies if the program was created by the supplier contact or the internal distributor user.
• InProgressAmount: number
  Read Only: true

  In-progress amount in the channel program.
• LastUpdateDate: string (date-time)
  Read Only: true

  Channel Programs
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Channel Programs
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• marketRules: array Market Rules
  Title: Market Rules

  The Market Rules resource manages rules for identifying eligible customers for a program. This resource has been superseded by the marketRulesV2 resource.
• marketRulesV2: array Market Rules V2
  Title: Market Rules V2

  Manages rules for identifying eligible supplier programs. For example, a market rule could be that the customer is Seven Corporation.
• notes: array Notes
  Title: Notes

  The note objects resource is used to view the note objects.
• OpenAmount: number
  Read Only: true

  Open amount in the channel program.
• OverrideProgramFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If it's true, then the channel programs that are automatically applied on sales orders can be overridden. If it's false, then the channel programs applied on sales orders can't be overridden. The value is defaulted from program type.
• Owner: string
  Name of the person who owns the channel 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 channel program.
• OwnerPersonNumber: string
  Maximum Length: 255

  Number that uniquely identifies the person who owns the channel program.
• PaidAmount: number
  Read Only: true

  Paid amount in the channel program.
• productRules: array Product Rules
  Title: Product Rules

  The Product Rules resource manages rules for identifying eligible products for a program.
• ProgramCode: string
  Maximum Length: 30

  Abbreviation that uniquely identifies the channel program.
• ProgramId: integer (int64)
  Value that uniquely identifies the channel program. It's a primary key that the application generates when it creates the program.
• ProgramName: string
  Title: Name

  Maximum Length: 240

  Name of the channel program.
• programRules: array Program Rules
  Title: Program Rules

  The Program Rules resource manages mandatory market rules for a program.
• ProgramTemplate: string
  Name of the predefined program template on which the channel 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 channel program is based.
• ProgramType: string
  Type of program on which the channel program is based.
• ProgramTypeId: integer (int64)
  Value that uniquely identifies the type of program on which the channel program is based.
• PurchasedAmount: number
  Read Only: true

  Purchase amount in the channel program.
• Status: string
  Status of the channel program.
• StatusId: integer (int64)
  Value that uniquely identifies the status of the channel program.
• Supplier: string
  Name of the supplier supporting the channel program.
• SupplierAuthorizationNumber: string
  Maximum Length: 30

  Number that identifies the authorization provided by supplier.
• SupplierContact: string
  Person who represents the supplier when communicating with the buyer.
• SupplierContactId: integer (int64)
  Channel Programs
• SupplierId: integer (int64)
  Channel Programs
• SupplierNumber: string
  Channel Programs
• SupplierQuoteNumber: string
  Maximum Length: 30

  Number that indicates the quote provided by supplier.
• SupplierSite: string
  Value that identifies the supplier site.
• SupplierSiteAddress: string
  Read Only: true

  Maximum Length: 255

  Address for the supplier site.
• SupplierSiteId: integer (int64)
  Channel Programs
• SystemStatus: string
  Read Only: true

  Maximum Length: 255

  System status of the supplier program.
• SystemStatusCode: string
  Maximum Length: 30

  Abbreviation that identifies the system status of the supplier program.
• ToDate: string (date)
  Channel Programs
• volumeRules: array Volume Rules
  Title: Volume Rules

  The Volume Rules resource manages volume rules of a volume program.

{
    "type":"object",
    "properties":{
        "ApplyManuallyToOrderFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If it's true, then the channel program isn't automatically applied on sales orders even if the eligibility criteria is met. If it's false, then the channel program is automatically applied on sales orders upon eligibility evaluation. The value is defaulted from program type.",
            "nullable":true,
            "x-queryable":true
        },
        "AvailableAmount":{
            "type":"number",
            "description":"Available amount in the channel program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnit":{
            "type":"string",
            "description":"Channel Programs",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Channel Programs",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "CalculationMethod":{
            "type":"string",
            "description":"Method used for calculating accruals in the channel program. A list of accepted values is defined in the lookup type ORA_CJM_TIER_CALC_METHOD.",
            "nullable":true,
            "x-queryable":true
        },
        "CalculationMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the calculation method used for calculating accruals in the channel program.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Channel Programs",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Channel Programs",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Currency":{
            "type":"string",
            "description":"Name of the currency used for the channel program.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the currency used for the channel program.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/channelPrograms-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"Description of the channel program.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "EarnedAmount":{
            "type":"number",
            "description":"Earned amount in the channel program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveDateType":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the effective date type used for evaluating supplier program eligibility. A list of accepted values is defined in the lookup type ORA_CJM_PRICING_APP_DATE_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveDateTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the sales order date type used for evaluating channel program eligibility. A list of accepted values is defined in the lookup type ORA_CJM_PRICING_APP_DATE_TYPE.",
            "nullable":false,
            "default":"FROM",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FromDate":{
            "type":"string",
            "description":"Channel Programs",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "InProgressAmount":{
            "type":"number",
            "description":"In-progress amount in the channel program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InitiatedBy":{
            "type":"string",
            "description":"Value that identifies if the program was created by the supplier contact or the internal distributor user.",
            "nullable":true,
            "x-queryable":true
        },
        "InitiatedByCode":{
            "maxLength":20,
            "type":"string",
            "description":"Abbreviation that identifies if the program was created by the supplier contact or the internal distributor user.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Channel Programs",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Channel Programs",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "OpenAmount":{
            "type":"number",
            "description":"Open amount in the channel program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OverrideProgramFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If it's true, then the channel programs that are automatically applied on sales orders can be overridden. If it's false, then the channel programs applied on sales orders can't be overridden. The value is defaulted from program type.",
            "nullable":true,
            "x-queryable":true
        },
        "Owner":{
            "type":"string",
            "description":"Name of the person who owns the channel program. This attribute defaults to the name of the person who creates the program.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "OwnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the person who owns the channel program.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "OwnerPersonNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that uniquely identifies the person who owns the channel program.",
            "nullable":true,
            "x-queryable":true
        },
        "PaidAmount":{
            "type":"number",
            "description":"Paid amount in the channel program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the channel program.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ProgramId":{
            "type":"integer",
            "description":"Value that uniquely identifies the channel program. It's a primary key that the application generates when it creates the program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ProgramName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the channel program.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ProgramTemplate":{
            "type":"string",
            "description":"Name of the predefined program template on which the channel program is based. A list of accepted values is defined in the lookup type ORA_CJM_PROGRAM_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramTemplateCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the predefined program template on which the channel program is based.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ProgramType":{
            "type":"string",
            "description":"Type of program on which the channel program is based.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ProgramTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the type of program on which the channel program is based.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "PurchasedAmount":{
            "type":"number",
            "description":"Purchase amount in the channel program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "type":"string",
            "description":"Status of the channel program.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "StatusId":{
            "type":"integer",
            "description":"Value that uniquely identifies the status of the channel program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "Supplier":{
            "type":"string",
            "description":"Name of the supplier supporting the channel program.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierAuthorizationNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the authorization provided by supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierContact":{
            "type":"string",
            "description":"Person who represents the supplier when communicating with the buyer.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierContactId":{
            "type":"integer",
            "description":"Channel Programs",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Channel Programs",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierNumber":{
            "type":"string",
            "description":"Channel Programs",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierQuoteNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that indicates the quote provided by supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierSite":{
            "type":"string",
            "description":"Value that identifies the supplier site.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierSiteAddress":{
            "maxLength":255,
            "type":"string",
            "description":"Address for the supplier site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Channel Programs",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SystemStatus":{
            "maxLength":255,
            "type":"string",
            "description":"System status of the supplier program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SystemStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the system status of the supplier program.",
            "nullable":false,
            "x-queryable":true
        },
        "ToDate":{
            "type":"string",
            "description":"Channel Programs",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "alternateSupplierSites":{
            "title":"Alternate Supplier Sites",
            "type":"array",
            "description":"The Alternate Supplier Sites resource manages alternate supplier sites of a supplier rebate program.",
            "items":{
                "$ref":"#/components/schemas/channelPrograms-alternateSupplierSites-item-response"
            }
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/channelPrograms-attachments-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "marketRules":{
            "title":"Market Rules",
            "type":"array",
            "description":"The Market Rules resource manages rules for identifying eligible customers for a program. This resource has been superseded by the marketRulesV2 resource.",
            "items":{
                "$ref":"#/components/schemas/channelPrograms-marketRules-item-response"
            }
        },
        "marketRulesV2":{
            "title":"Market Rules V2",
            "type":"array",
            "description":"Manages rules for identifying eligible supplier programs. For example, a market rule could be that the customer is Seven Corporation.",
            "items":{
                "$ref":"#/components/schemas/channelPrograms-marketRulesV2-item-response"
            }
        },
        "notes":{
            "title":"Notes",
            "type":"array",
            "description":"The note objects resource is used to view the note objects.",
            "items":{
                "$ref":"#/components/schemas/channelPrograms-notes-item-response"
            }
        },
        "productRules":{
            "title":"Product Rules",
            "type":"array",
            "description":"The Product Rules resource manages rules for identifying eligible products for a program.",
            "items":{
                "$ref":"#/components/schemas/channelPrograms-productRules-item-response"
            }
        },
        "programRules":{
            "title":"Program Rules",
            "type":"array",
            "description":"The Program Rules resource manages mandatory market rules for a program.",
            "items":{
                "$ref":"#/components/schemas/channelPrograms-programRules-item-response"
            }
        },
        "volumeRules":{
            "title":"Volume Rules",
            "type":"array",
            "description":"The Volume Rules resource manages volume rules of a volume program.",
            "items":{
                "$ref":"#/components/schemas/channelPrograms-volumeRules-item-response"
            }
        }
    }
}

Nested Schema : Alternate Supplier Sites

Type: array

Title: Alternate Supplier Sites

The Alternate Supplier Sites resource manages alternate supplier sites of a supplier rebate program.

Show Source

• Array of: object channelPrograms-alternateSupplierSites-item-response

{
    "title":"Alternate Supplier Sites",
    "type":"array",
    "description":"The Alternate Supplier Sites resource manages alternate supplier sites of a supplier rebate program.",
    "items":{
        "$ref":"#/components/schemas/channelPrograms-alternateSupplierSites-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 channelPrograms-attachments-item-response

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

Nested Schema : DFF

Type: array

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/channelPrograms-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 : Market Rules

Type: array

Title: Market Rules

The Market Rules resource manages rules for identifying eligible customers for a program. This resource has been superseded by the marketRulesV2 resource.

Show Source

• Array of: object channelPrograms-marketRules-item-response

{
    "title":"Market Rules",
    "type":"array",
    "description":"The Market Rules resource manages rules for identifying eligible customers for a program. This resource has been superseded by the marketRulesV2 resource.",
    "items":{
        "$ref":"#/components/schemas/channelPrograms-marketRules-item-response"
    }
}

Nested Schema : Market Rules V2

Type: array

Title: Market Rules V2

Manages rules for identifying eligible supplier programs. For example, a market rule could be that the customer is Seven Corporation.

Show Source

• Array of: object channelPrograms-marketRulesV2-item-response

{
    "title":"Market Rules V2",
    "type":"array",
    "description":"Manages rules for identifying eligible supplier programs. For example, a market rule could be that the customer is Seven Corporation.",
    "items":{
        "$ref":"#/components/schemas/channelPrograms-marketRulesV2-item-response"
    }
}

Nested Schema : Notes

Type: array

Title: Notes

The note objects resource is used to view the note objects.

Show Source

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

{
    "title":"Notes",
    "type":"array",
    "description":"The note objects resource is used to view the note objects.",
    "items":{
        "$ref":"#/components/schemas/channelPrograms-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 channelPrograms-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/channelPrograms-productRules-item-response"
    }
}

Nested Schema : Program Rules

Type: array

Title: Program Rules

The Program Rules resource manages mandatory market rules for a program.

Show Source

• Array of: object channelPrograms-programRules-item-response

{
    "title":"Program Rules",
    "type":"array",
    "description":"The Program Rules resource manages mandatory market rules for a program.",
    "items":{
        "$ref":"#/components/schemas/channelPrograms-programRules-item-response"
    }
}

Nested Schema : Volume Rules

Type: array

Title: Volume Rules

The Volume Rules resource manages volume rules of a volume program.

Show Source

• Array of: object channelPrograms-volumeRules-item-response

{
    "title":"Volume Rules",
    "type":"array",
    "description":"The Volume Rules resource manages volume rules of a volume program.",
    "items":{
        "$ref":"#/components/schemas/channelPrograms-volumeRules-item-response"
    }
}

Nested Schema : channelPrograms-alternateSupplierSites-item-response

Type: object

Show Source

• AlternateSupplierSiteId: integer (int64)
  Value that uniquely identifies the alternate supplier site.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Alternate Supplier Sites
• LastUpdateDate: string (date-time)
  Read Only: true

  Alternate Supplier Sites
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Alternate Supplier Sites
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProcurementBusinessUnit: string
  Name of the procurement business unit.
• ProcurementBusinessUnitId: integer
  Value that uniquely identifies the procurement business unit.
• Supplier: string
  Name of the alternate supplier supporting the channel program.
• SupplierId: integer
  Value that uniquely identifies the alternate supplier.
• SupplierNumber: string
  Number that identifies the alternate supplier.
• SupplierSite: string
  Maximum Length: 240

  Name of the alternate supplier site.
• SupplierSiteAddress: string
  Maximum Length: 4000

  Address of the alternate supplier site.
• SupplierSiteId: integer (int64)
  Value that identifies the alternate supplier site.

{
    "type":"object",
    "properties":{
        "AlternateSupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the alternate supplier site.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Alternate Supplier Sites",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Alternate Supplier Sites",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Alternate Supplier Sites",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Alternate Supplier Sites",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBusinessUnit":{
            "type":"string",
            "description":"Name of the procurement business unit.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcurementBusinessUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit.",
            "nullable":true,
            "x-queryable":true
        },
        "Supplier":{
            "type":"string",
            "description":"Name of the alternate supplier supporting the channel program.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the alternate supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierNumber":{
            "type":"string",
            "description":"Number that identifies the alternate supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierSite":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the alternate supplier site.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierSiteAddress":{
            "maxLength":4000,
            "type":"string",
            "description":"Address of the alternate supplier site.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that identifies the alternate supplier site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

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

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

  Maximum Length: 30

  The 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

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

  Read Only: true

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

  Read Only: true

  The 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

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

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

  Maximum Length: 1000

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

  The 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

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

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

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

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

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

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

  Read Only: true

  The 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

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

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

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

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

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

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

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

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

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

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

  Maximum Length: 4000

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

  Maximum Length: 4000

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

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The 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
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "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"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "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
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The 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
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "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"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The 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"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The 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
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The 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":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The 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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : channelPrograms-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• links: array Links
  Title: Links

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

{
    "type":"object",
    "properties":{
        "ProgramHeaderId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Context Segment",
            "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_IsDiscriminator":"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
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : channelPrograms-marketRules-item-response

Type: object

Show Source

• ComparisonOperatorCode: string
  Maximum Length: 30

  Abbreviation that identifies the comparison operator used in market rule. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.
• conditions: array Conditions
  Title: Conditions

  The Conditions resource manages additional conditions for a market rule of a program.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Market Rules
• FromDate: string (date)
  Date when the qualifier becomes applicable.
• LastUpdateDate: string (date-time)
  Read Only: true

  Market Rules
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Market Rules
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProgramId: integer (int64)
  Value that uniquely identifies the channel program.
• QualifierId: integer (int64)
  Value that uniquely identifies the market rule. It's a primary key that the application generates when it creates the market rule.
• QualifierType: string
  Maximum Length: 255

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

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

  Maximum Length: 255

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

  Abbreviation that identifies the qualifier used in channel program qualification.
• ToDate: string (date)
  Date when the qualifier is no longer applicable.

{
    "type":"object",
    "properties":{
        "ComparisonOperatorCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the comparison operator used in market rule. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Market Rules",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Market Rules",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "FromDate":{
            "type":"string",
            "description":"Date when the qualifier becomes applicable.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Market Rules",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Market Rules",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ProgramId":{
            "type":"integer",
            "description":"Value that uniquely identifies the channel program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "QualifierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the market rule. It's a primary key that the application generates when it creates the market rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "QualifierType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of qualifier used to define the eligibility of the channel program. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_TYPE.",
            "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 channel program.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "QualifierValue":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the qualifier used in channel program qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "QualifierValueCode":{
            "maxLength":240,
            "type":"string",
            "description":"Abbreviation that identifies the qualifier used in channel program qualification.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ToDate":{
            "type":"string",
            "description":"Date when the qualifier is no longer applicable.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "conditions":{
            "title":"Conditions",
            "type":"array",
            "description":"The Conditions resource manages additional conditions for a market rule of a program.",
            "items":{
                "$ref":"#/components/schemas/channelPrograms-marketRules-conditions-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Conditions

Type: array

Title: Conditions

The Conditions resource manages additional conditions for a market rule of a program.

Show Source

• Array of: object channelPrograms-marketRules-conditions-item-response

{
    "title":"Conditions",
    "type":"array",
    "description":"The Conditions resource manages additional conditions for a market rule of a program.",
    "items":{
        "$ref":"#/components/schemas/channelPrograms-marketRules-conditions-item-response"
    }
}

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 : channelPrograms-marketRules-conditions-item-response

Type: object

Show Source

• ComparisonOperatorCode: string
  Maximum Length: 30

  Abbreviation that identifies the comparison operator used in the market rule condition. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Conditions
• LastUpdateDate: string (date-time)
  Read Only: true

  Conditions
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Conditions
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• QualifierConditionId: integer (int64)
  Value that uniquely identifies the market rule condition. It's a primary key that the application generates when it creates the market rule condition.
• QualifierId: integer (int64)
  Value that uniquely identifies the market rule.
• QualifierType: string
  Type of qualifier used to define the eligibility of the channel program. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_TYPE.
• QualifierTypeCode: string
  Maximum Length: 30

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

  Maximum Length: 255

  Type of qualifier used in the channel program qualification.
• QualifierValueCode: string
  Maximum Length: 240

  Abbreviation that identifies the qualifier used in channel program qualification.

{
    "type":"object",
    "properties":{
        "ComparisonOperatorCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the comparison operator used in the market rule condition. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Conditions",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Conditions",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Conditions",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Conditions",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QualifierConditionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the market rule condition. It's a primary key that the application generates when it creates the market rule condition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QualifierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the market rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QualifierType":{
            "type":"string",
            "description":"Type of qualifier used to define the eligibility of the channel program. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_TYPE.",
            "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 channel program eligibility.",
            "nullable":false,
            "x-queryable":true
        },
        "QualifierValue":{
            "maxLength":255,
            "type":"string",
            "description":"Type of qualifier used in the channel program qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "QualifierValueCode":{
            "maxLength":240,
            "type":"string",
            "description":"Abbreviation that identifies the qualifier used in channel program qualification.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

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

  Address for the customer. It applies if the qualifier type is Customer, Bill-to Account or Ship To.
• 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 market rule. 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 market rule.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Market Rules V2
• Customer: string
  Read Only: true

  Maximum Length: 255

  Market Rules V2
• 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.
• FromDate: string (date)
  Date when the market rule becomes applicable.
• LastUpdateDate: string (date-time)
  Read Only: true

  Market Rules V2
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Market Rules V2
• links: array Links
  Title: Links

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

  Market Rules V2
• ParentRuleId: integer (int64)
  Value that identifies the parent market rule.
• ProgramId: integer (int64)
  Value that uniquely identifies the supplier program.
• QualifierNumberValueCode: integer
  Read Only: true

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

  Type of qualifier used to define the eligibility of the supplier program. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_TYPE for supplier ship and debit programs and the lookup type ORA_CJM_SUP_REBATE_QUAL for supplier rebate programs.
• QualifierTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of qualifier used to define the eligibility of the supplier program.
• QualifierValue: string
  Maximum Length: 255

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

  Abbreviation that identifies the qualifier used in the supplier program qualification.
• RuleId: integer (int64)
  Value that uniquely identifies the market rule. It's a primary key that the application generates when it creates the market rule.
• 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.
• Site: string
  Read Only: true

  Maximum Length: 255

  Name of the bill-to customer account site or the ship-to site.
• ToDate: string (date)
  Date when the market rule is no longer applicable.

{
    "type":"object",
    "properties":{
        "AccountNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number of the bill-to customer account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address":{
            "maxLength":255,
            "type":"string",
            "description":"Address for the customer. It applies if the qualifier type is Customer, Bill-to Account or Ship To.",
            "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. <br>Validation: 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
        },
        "ComparisonOperator":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the comparison operator used in the market rule. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.",
            "nullable":true,
            "x-queryable":true
        },
        "ComparisonOperatorCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the comparison operator used in the market rule.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Market Rules V2",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Market Rules V2",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "Customer":{
            "maxLength":255,
            "type":"string",
            "description":"Market Rules V2",
            "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
        },
        "DomainLookupTypeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Lookup type code for the dimension of the lookup domain type.",
            "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
        },
        "FromDate":{
            "type":"string",
            "description":"Date when the market rule becomes applicable.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Market Rules V2",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Market Rules V2",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MatrixDimensionId":{
            "type":"integer",
            "description":"Market Rules V2",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentRuleId":{
            "type":"integer",
            "description":"Value that identifies the parent market rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProgramId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QualifierNumberValueCode":{
            "type":"integer",
            "description":"Value of the numeric qualifier used in the supplier program qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QualifierType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of qualifier used to define the eligibility of the supplier program. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_TYPE for supplier ship and debit programs and the lookup type ORA_CJM_SUP_REBATE_QUAL for supplier rebate programs.",
            "nullable":true,
            "x-queryable":true
        },
        "QualifierTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of qualifier used to define the eligibility of the supplier program.",
            "nullable":false,
            "x-queryable":true
        },
        "QualifierValue":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the qualifier used in the supplier program qualification.",
            "nullable":true,
            "x-queryable":true
        },
        "QualifierValueCode":{
            "maxLength":240,
            "type":"string",
            "description":"Abbreviation that identifies the qualifier used in the supplier program qualification.",
            "nullable":false,
            "x-queryable":true
        },
        "RuleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the market rule. It's a primary key that the application generates when it creates the market rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":4
            },
            "x-queryable":true
        },
        "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
        },
        "ToDate":{
            "type":"string",
            "description":"Date when the market rule is no longer applicable.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : channelPrograms-notes-item-response

Type: object

Show Source

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

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

  Maximum Length: 15

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

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

  The unique identifier of the party.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

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

  Maximum Length: 15

  The currency code for extensibility.
• DeleteFlag: boolean
  Title: Delete Indicator

  Read Only: true

  Indicates whether the user has access to delete the note.
• EmailAddress: string
  Read Only: true

  Maximum Length: 320

  The email address of the user who created the note.
• FormattedAddress: string
  Read Only: true

  The address of the user who created the note.
• FormattedPhoneNumber: string
  Read Only: true

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The unique identifier of the note. This is the primary key of the notes table.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The 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

  The unique identifier of the note. This is the primary key of the notes table.
• NoteNumber: string
  Maximum Length: 30

  The 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

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

  The column which stores the actual note text.
• NoteTypeCode: string
  Title: Type

  Maximum Length: 30

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

  The unique identifier of the note. This is the primary key of the notes table.
• PartyId: integer (int64)
  Read Only: true

  The unique identifier of the party.
• PartyName: string
  Title: Author

  Read Only: true

  Maximum Length: 360

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

  Maximum Length: 30

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

  Maximum Length: 64

  The unique identifier of the parent source object associated to the note.
• SourceSystem: string
  Title: Source System

  Maximum Length: 30

  This is the source object code for the source object as defined in OBJECTS Metadata.
• 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

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

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : channelPrograms-productRules-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Product Rules
• DFF: array DFF
• DiscountType: string
  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.
• DiscountValue: number
  Value of the discount.
• FromDate: string (date)
  Date when the product rule becomes applicable.
• Item: string
  Name of the item in the inventory.
• ItemDescription: string
  Description of the item in the inventory.
• ItemId: string
  Maximum Length: 240

  Value that uniquely identifies the item in the inventory.
• ItemLevel: string
  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

  Product Rules
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Product Rules
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumQuantity: number
  Maximum quantity allowed for each product rule.
• ProgramId: integer (int64)
  Name that identifies the qualifier used in the channel program qualification.
• ProgramLineId: integer
  Value that uniquely identifies the product rule. It's a primary key that the application generates when it creates the product rule.
• SupplierItem: string
  Maximum Length: 255

  Name of the supplier item.
• SupplierItemDescription: string
  Maximum Length: 255

  Description of the supplier item.
• SupplierItemId: integer (int64)
  Value that uniquely identifies the supplier item.
• ToDate: string (date)
  Date when the product rule is no longer applicable.
• UnitOfMeasure: string
  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":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Product Rules",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Product Rules",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/channelPrograms-productRules-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "DiscountType":{
            "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
        },
        "DiscountTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of discount.",
            "nullable":false,
            "x-queryable":false
        },
        "DiscountValue":{
            "type":"number",
            "description":"Value of the discount.",
            "nullable":false,
            "x-queryable":false
        },
        "FromDate":{
            "type":"string",
            "description":"Date when the product rule becomes applicable.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "Item":{
            "type":"string",
            "description":"Name of the item in the inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "type":"string",
            "description":"Description of the item in the inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemId":{
            "maxLength":240,
            "type":"string",
            "description":"Value that uniquely identifies the item in the inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemLevel":{
            "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
        },
        "ItemLevelCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the level at which discounts are defined.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Product Rules",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Product Rules",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumQuantity":{
            "type":"number",
            "description":"Maximum quantity allowed for each product rule.",
            "nullable":true,
            "x-queryable":false
        },
        "ProgramId":{
            "type":"integer",
            "description":"Name that identifies the qualifier used in the channel program qualification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProgramLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the product rule. It's a primary key that the application generates when it creates the product rule.",
            "nullable":false,
            "x-queryable":true
        },
        "SupplierItem":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the supplier item.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierItemDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the supplier item.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ToDate":{
            "type":"string",
            "description":"Date when the product rule is no longer applicable.",
            "format":"date",
            "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
        },
        "UnitOfMeasure":{
            "type":"string",
            "description":"Unit of measure of the item for pricing.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : DFF

Type: array

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/channelPrograms-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 : channelPrograms-productRules-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProgramLineId: integer

{
    "type":"object",
    "properties":{
        "ProgramLineId":{
            "type":"integer",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Context Segment",
            "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_IsDiscriminator":"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
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

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

  Address for the customer. It applies if the qualifier type is Customer, Bill-to Account, or Ship To.
• ComparisonOperator: string
  Maximum Length: 255

  Name of the comparison operator used in the program rule. 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 program rule. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Program Rules
• Customer: string
  Read Only: true

  Maximum Length: 255

  Program Rules
• CustomQualifierFlag: boolean
  Read Only: true

  Maximum Length: 255

  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 timestamp. Accepted values are 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 within the lookup domain type.
• DomainTypeCode: string
  Read Only: true

  Maximum Length: 255

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

  Program Rules
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Program Rules
• links: array Links
  Title: Links

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

  Program Rules
• ProgramId: integer (int64)
  Value that uniquely identifies the channel program.
• QualifierId: integer (int64)
  Value that uniquely identifies the program rule.
• QualifierNumberValueCode: integer
  Read Only: true

  Value of the numeric qualifier used in the supplier program qualification.
• QualifierType: string
  Type of qualifier used to define eligibility of the channel program. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_TYPE.
• QualifierTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of qualifier used to define channel program eligibility.
• QualifierValue: string
  Maximum Length: 255

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

  Abbreviation that identifies the qualifier used in channel 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":{
        "AccountNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number of the bill-to customer account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Address":{
            "maxLength":255,
            "type":"string",
            "description":"Address for the customer. It applies if the qualifier type is Customer, Bill-to Account, or Ship To.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ComparisonOperator":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the comparison operator used in the program rule. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.",
            "nullable":true,
            "x-queryable":true
        },
        "ComparisonOperatorCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the comparison operator used in the program rule. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Program Rules",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Program Rules",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CustomQualifierFlag":{
            "maxLength":255,
            "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":false
        },
        "Customer":{
            "maxLength":255,
            "type":"string",
            "description":"Program Rules",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DomainDataTypeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Type of dimension data. Valid values include text, number, date, and timestamp. Accepted values are defined in the lookup type ORA_QP_MTRXR_DIMN_DATA_TYPES.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DomainLookupTypeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Lookup type code for the dimension within the lookup domain type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DomainTypeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Type of domain. Valid values include lookup, view object query, and custom. Accepted values are defined in the lookup type ORA_QP_MTRXR_DIMN_DOMAIN_TYPES.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Program Rules",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Program Rules",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "MatrixDimensionId":{
            "type":"integer",
            "description":"Program Rules",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProgramId":{
            "type":"integer",
            "description":"Value that uniquely identifies the channel program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "QualifierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the program rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "QualifierNumberValueCode":{
            "type":"integer",
            "description":"Value of the numeric qualifier used in the supplier program qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "QualifierType":{
            "type":"string",
            "description":"Type of qualifier used to define eligibility of the channel program. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_TYPE.",
            "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 channel program eligibility.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "QualifierValue":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the qualifier used in channel program qualification.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "QualifierValueCode":{
            "maxLength":240,
            "type":"string",
            "description":"Abbreviation that identifies the qualifier used in channel program qualification.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "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":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : channelPrograms-volumeRules-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Volume Rules
• DiscountType: string
  Read Only: true

  Type of discount. A list of accepted values is defined in the lookup type ORA_CJM_LINE_DISCOUNT_TYPE.
• DiscountTypeCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the type of discount.
• LastUpdateDate: string (date-time)
  Read Only: true

  Volume Rules
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Volume Rules
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login credentials that the user used to update the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• products: array Products
  Title: Products

  The Products resource manages the eligible products for a volume program.
• ProgramId: integer (int64)
  Read Only: true

  Value that uniquely identifies the channel program.
• tiers: array Tiers
  Title: Tiers

  The Tiers resource manages the tier definition of a volume program.
• TierType: string
  Tier types supported in the channel program. A list of accepted values is defined in the lookup type ORA_CJM_TIER_TYPE.
• TierTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the tier type.
• UnitOfMeasure: string
  Unit of measure of the item.
• UOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure.
• VolumeRuleId: integer (int64)
  Read Only: true

  Value that uniquely identifies the volume rule.
• VolumeRuleName: string
  Maximum Length: 240

  Name of the volume rule.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Volume Rules",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Volume Rules",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DiscountType":{
            "type":"string",
            "description":"Type of discount. A list of accepted values is defined in the lookup type ORA_CJM_LINE_DISCOUNT_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DiscountTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of discount.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Volume Rules",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login credentials that the user used to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Volume Rules",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramId":{
            "type":"integer",
            "description":"Value that uniquely identifies the channel program.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TierType":{
            "type":"string",
            "description":"Tier types supported in the channel program. A list of accepted values is defined in the lookup type ORA_CJM_TIER_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "TierTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the tier type.",
            "nullable":false,
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "type":"string",
            "description":"Unit of measure of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "VolumeRuleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the volume rule.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "VolumeRuleName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the volume rule.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "products":{
            "title":"Products",
            "type":"array",
            "description":"The Products resource manages the eligible products for a volume program.",
            "items":{
                "$ref":"#/components/schemas/channelPrograms-volumeRules-products-item-response"
            }
        },
        "tiers":{
            "title":"Tiers",
            "type":"array",
            "description":"The Tiers resource manages the tier definition of a volume program.",
            "items":{
                "$ref":"#/components/schemas/channelPrograms-volumeRules-tiers-item-response"
            }
        }
    }
}

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 : Products

Type: array

Title: Products

The Products resource manages the eligible products for a volume program.

Show Source

• Array of: object channelPrograms-volumeRules-products-item-response

{
    "title":"Products",
    "type":"array",
    "description":"The Products resource manages the eligible products for a volume program.",
    "items":{
        "$ref":"#/components/schemas/channelPrograms-volumeRules-products-item-response"
    }
}

Nested Schema : Tiers

Type: array

Title: Tiers

The Tiers resource manages the tier definition of a volume program.

Show Source

• Array of: object channelPrograms-volumeRules-tiers-item-response

{
    "title":"Tiers",
    "type":"array",
    "description":"The Tiers resource manages the tier definition of a volume program.",
    "items":{
        "$ref":"#/components/schemas/channelPrograms-volumeRules-tiers-item-response"
    }
}

Nested Schema : channelPrograms-volumeRules-products-item-response

Type: object

Show Source

• Category: string
  Products
• CategoryCode: string
  Abbreviation that identifies the category.
• CategoryDescription: string
  Description of the category.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Products
• exclusions: array Exclusions
  Title: Exclusions

  The Exclusions resource manages the product or category exclusions from the volume program.
• IncludeVolumeExcludeDiscountFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the product volume is considered for tier calculation but not for any discount. If false, then the product volume is considered for tier calculation and for discounts. The default value is false.
• Item: string
  Name of the item in the inventory.
• ItemDescription: string
  Description of the item in the inventory.
• ItemId: string
  Maximum Length: 240

  Value that uniquely identifies the item in the inventory.
• LastUpdateDate: string (date-time)
  Read Only: true

  Products
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Products
• LineLevel: string
  Level at which discounts are defined. A list of accepted values is defined in the lookup type ORA_CJM_PROG_ITEM_LEVEL.
• LineLevelCode: string
  Maximum Length: 30

  Abbreviation that identifies the level at which discounts are defined.
• LineNumber: number
  Number that identifies the product line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProductId: integer
  Value that uniquely identifies the product line.
• SupplierItem: string
  Name of the supplier item.
• SupplierItemDescription: string
  Description of the supplier item.
• SupplierItemId: integer (int64)
  Value that uniquely identifies the supplier item.
• VolumeRuleId: integer (int64)
  Value that uniquely identifies the volume rule.

{
    "type":"object",
    "properties":{
        "Category":{
            "type":"string",
            "description":"Products",
            "nullable":true,
            "x-queryable":true
        },
        "CategoryCode":{
            "type":"string",
            "description":"Abbreviation that identifies the category.",
            "nullable":true,
            "x-queryable":true
        },
        "CategoryDescription":{
            "type":"string",
            "description":"Description of the category.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Products",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Products",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IncludeVolumeExcludeDiscountFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the product volume is considered for tier calculation but not for any discount. If false, then the product volume is considered for tier calculation and for discounts. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "Item":{
            "type":"string",
            "description":"Name of the item in the inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "type":"string",
            "description":"Description of the item in the inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemId":{
            "maxLength":240,
            "type":"string",
            "description":"Value that uniquely identifies the item in the inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Products",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Products",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineLevel":{
            "type":"string",
            "description":"Level at which discounts are defined. A list of accepted values is defined in the lookup type ORA_CJM_PROG_ITEM_LEVEL.",
            "nullable":true,
            "x-queryable":true
        },
        "LineLevelCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the level at which discounts are defined.",
            "nullable":true,
            "x-queryable":true
        },
        "LineNumber":{
            "type":"number",
            "description":"Number that identifies the product line.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductId":{
            "type":"integer",
            "description":"Value that uniquely identifies the product line.",
            "nullable":false,
            "x-queryable":true
        },
        "SupplierItem":{
            "type":"string",
            "description":"Name of the supplier item.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierItemDescription":{
            "type":"string",
            "description":"Description of the supplier item.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "VolumeRuleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the volume rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "exclusions":{
            "title":"Exclusions",
            "type":"array",
            "description":"The Exclusions resource manages the product or category exclusions from the volume program.",
            "items":{
                "$ref":"#/components/schemas/channelPrograms-volumeRules-products-exclusions-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Exclusions

Type: array

Title: Exclusions

The Exclusions resource manages the product or category exclusions from the volume program.

Show Source

• Array of: object channelPrograms-volumeRules-products-exclusions-item-response

{
    "title":"Exclusions",
    "type":"array",
    "description":"The Exclusions resource manages the product or category exclusions from the volume program.",
    "items":{
        "$ref":"#/components/schemas/channelPrograms-volumeRules-products-exclusions-item-response"
    }
}

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 : channelPrograms-volumeRules-products-exclusions-item-response

Type: object

Show Source

• Category: string
  Exclusions
• CategoryCode: string
  Abbreviation that identifies the category.
• CategoryDescription: string
  Description of the category.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Exclusions
• ExclusionId: integer (int64)
  Value that uniquely identifies the exclusion.
• Item: string
  Name of the item in the inventory.
• ItemDescription: string
  Description of the item in the inventory.
• ItemId: string
  Maximum Length: 240

  Value that uniquely identifies the item in the inventory.
• LastUpdateDate: string (date-time)
  Read Only: true

  Exclusions
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Exclusions
• LineLevel: string
  Level at which discounts are defined. A list of accepted values is defined in the lookup type ORA_CJM_PROG_ITEM_LEVEL.
• LineLevelCode: string
  Maximum Length: 30

  Abbreviation that identifies the level at which discounts are defined.
• LineNumber: number
  Number that identifies the product line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProductId: integer (int64)
  Value that uniquely identifies the product line.
• SupplierItem: string
  Name of the supplier item.
• SupplierItemDescription: string
  Description of the supplier item.
• SupplierItemId: integer (int64)
  Value that uniquely identifies the supplier item.

{
    "type":"object",
    "properties":{
        "Category":{
            "type":"string",
            "description":"Exclusions",
            "nullable":true,
            "x-queryable":true
        },
        "CategoryCode":{
            "type":"string",
            "description":"Abbreviation that identifies the category.",
            "nullable":true,
            "x-queryable":true
        },
        "CategoryDescription":{
            "type":"string",
            "description":"Description of the category.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Exclusions",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Exclusions",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExclusionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the exclusion.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Item":{
            "type":"string",
            "description":"Name of the item in the inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "type":"string",
            "description":"Description of the item in the inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemId":{
            "maxLength":240,
            "type":"string",
            "description":"Value that uniquely identifies the item in the inventory.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Exclusions",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Exclusions",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineLevel":{
            "type":"string",
            "description":"Level at which discounts are defined. A list of accepted values is defined in the lookup type ORA_CJM_PROG_ITEM_LEVEL.",
            "nullable":true,
            "x-queryable":true
        },
        "LineLevelCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the level at which discounts are defined.",
            "nullable":false,
            "x-queryable":true
        },
        "LineNumber":{
            "type":"number",
            "description":"Number that identifies the product line.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductId":{
            "type":"integer",
            "description":"Value that uniquely identifies the product line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierItem":{
            "type":"string",
            "description":"Name of the supplier item.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierItemDescription":{
            "type":"string",
            "description":"Description of the supplier item.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : channelPrograms-volumeRules-tiers-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Tiers
• LastUpdateDate: string (date-time)
  Read Only: true

  Tiers
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Tiers
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PreQualifyingTierFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If it's true, then the tier calculation starts from the corresponding tier. If it's false, then the tier calculation starts from the first tier. The default value is false.
• TierDiscount: number
  Value of the tier discount.
• TierFrom: number
  Value from which the tier is eligible.
• TierId: integer (int64)
  Read Only: true

  Value that uniquely identifies the tier.
• TierName: string
  Maximum Length: 240

  Name of the tier.
• TierNumber: number
  Read Only: true

  Number that identifies the tier.
• TierTo: number
  Value till the tier is eligible.
• VolumeRuleId: integer (int64)
  Read Only: true

  Value that uniquely identifies the volume rule.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Tiers",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Tiers",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Tiers",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Tiers",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PreQualifyingTierFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If it's true, then the tier calculation starts from the corresponding tier. If it's false, then the tier calculation starts from the first tier. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "TierDiscount":{
            "type":"number",
            "description":"Value of the tier discount.",
            "nullable":false,
            "x-queryable":true
        },
        "TierFrom":{
            "type":"number",
            "description":"Value from which the tier is eligible.",
            "nullable":true,
            "x-queryable":true
        },
        "TierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the tier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TierName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the tier.",
            "nullable":false,
            "x-queryable":true
        },
        "TierNumber":{
            "type":"number",
            "description":"Number that identifies the tier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TierTo":{
            "type":"number",
            "description":"Value till the tier is eligible.",
            "nullable":true,
            "x-queryable":true
        },
        "VolumeRuleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the volume rule.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Links

DFF

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

Parameters:

• ProgramId: $request.path.ProgramId

EffectiveDateTypeVVO

Parameters:

• finder: findProgramTypeDateQualifiers%3BbindProgramTypeId%3D{ProgramTypeId}

The following properties are defined on the LOV link relation:

• Source Attribute: EffectiveDateTypeCode; Target Attribute: QualifierTypeCode
• Display Attribute: QualifierType

FinFunBusinessUnitVO

Operation: /fscmRestApi/resources/11.13.18.05/finBusinessUnitsLOV

Parameters:

• finder: ServiceProviderFinder%3BIntent%3DCJM_MANAGE_CHANNEL_PROGRAMS_DATA%2CModuleId%3D30%2CDownstreamFunctionId%3D20%2CUpstreamFunctionId%3D10

The following properties are defined on the LOV link relation:

• Source Attribute: BusinessUnitId; Target Attribute: BusinessUnitId
• Display Attribute: BusinessUnitName

OwnersVVO

Operation: /fscmRestApi/resources/11.13.18.05/channelOwnersLOV

Parameters:

• finder: ActiveOwnerFinder

The following properties are defined on the LOV link relation:

• Source Attribute: OwnerId; Target Attribute: PersonId
• Display Attribute: Name, Email, BusinessTitle

ProgramTypeVO

Parameters:

• finder: FindBySupplierProgramTemplate

The following properties are defined on the LOV link relation:

• Source Attribute: ProgramTypeId; Target Attribute: ProgramTypeId
• Display Attribute: ProgramTypeName

UserStatusVO

Parameters:

• finder: BuySideStatusFinder%3BbindUserStatusForCode%3DPROGRAM

The following properties are defined on the LOV link relation:

• Source Attribute: StatusId; Target Attribute: UserStatusId
• Display Attribute: UserStatusName

alternateSupplierSites

Operation: /fscmRestApi/resources/11.13.18.05/channelPrograms/{ProgramId}/child/alternateSupplierSites

Parameters:

• ProgramId: $request.path.ProgramId

The Alternate Supplier Sites resource manages alternate supplier sites of a supplier rebate program.

attachments

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

Parameters:

• ProgramId: $request.path.ProgramId

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

marketRules

Operation: /fscmRestApi/resources/11.13.18.05/channelPrograms/{ProgramId}/child/marketRules

Parameters:

• ProgramId: $request.path.ProgramId

The Market Rules resource manages rules for identifying eligible customers for a program. This resource has been superseded by the marketRulesV2 resource.

marketRulesV2

Operation: /fscmRestApi/resources/11.13.18.05/channelPrograms/{ProgramId}/child/marketRulesV2

Parameters:

• ProgramId: $request.path.ProgramId

Manages rules for identifying eligible supplier programs. For example, a market rule could be that the customer is Seven Corporation.

notes

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

Parameters:

• ProgramId: $request.path.ProgramId

The note objects resource is used to view the note objects.

productRules

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

Parameters:

• ProgramId: $request.path.ProgramId

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

programRules

Operation: /fscmRestApi/resources/11.13.18.05/channelPrograms/{ProgramId}/child/programRules

Parameters:

• ProgramId: $request.path.ProgramId

The Program Rules resource manages mandatory market rules for a program.

volumeRules

Operation: /fscmRestApi/resources/11.13.18.05/channelPrograms/{ProgramId}/child/volumeRules

Parameters:

• ProgramId: $request.path.ProgramId

The Volume Rules resource manages volume rules of a volume program.

Back to Top

Examples

This example describes how to get one program.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/channelPrograms/ProgramId"

For example, the following command gets one program:

curl -u username:password "https://servername/fscmRestApi/resources/version/channelPrograms/300100185773659"

Example Response Body

The following shows an example of the response body in JSON format.

{
	"ProgramId": 300100185773659,
	"ProgramType": "Sales Initiated",
	"ProgramTypeId": 300100185735482,
	"ProgramTemplate": "Supplier Ship and Debit",
	"ProgramTemplateCode": "SUPPLIER_SHIP_AND_DEBIT",
	"BusinessUnit": "Vision Operations",
	"BusinessUnitId": 204,
	"ProgramName": "NY Vendor Rebate",
	"ProgramCode": "SSD13000",
	"Owner": "channel_user",
	"OwnerId": 300100181693728,
	"Status": "Active",
	"StatusId": 300100183528749,
	"Currency": "US Dollar",
	"CurrencyCode": "USD",
	"Description": null,
	"CreatedBy": "channel_user",
	"CreationDate": "2020-06-03T01:58:33+00:00",
	"LastUpdatedBy": "channel_user",
	"LastUpdateDate": "2020-06-03T01:58:35.823+00:00",
	"Supplier": "CDS, Inc",
	"SupplierId": 1178,
	"SupplierNumber": "5102",
	"SupplierSite": "PITTSBURGH",
	"SupplierSiteId": 2854,
	"SupplierAuthorizationNumber": null,
	"SupplierQuoteNumber": null,
	"EffectiveDateTypeCode": "REQ_SHIP_DATE",
	"FromDate": "2020-06-03",
	"ToDate": "2021-06-03",
	"ApplyManuallyToOrderFlag": false,
	"OverrideProgramFlag": true,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/channelPrograms/300100185773659",
		"name": "channelPrograms",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/channelPrograms/300100185773659",
		"name": "channelPrograms",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/channelPrograms/300100185773659/child/DFF",
		"name": "DFF",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/channelPrograms/300100185773659/child/marketRules",
		"name": "marketRules",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/channelPrograms/300100185773659/child/productRules",
		"name": "productRules",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/channelPrograms/300100185773659/child/programRules",
		"name": "programRules",
		"kind": "collection"
	}
	]
}

Back to Top