Jump to

• Request
• Response

Create one product distribution

post

/fscmRestApi/resources/11.13.18.05/channelCustomerLumpSumPrograms/{ProgramId}/child/productDistributions

Request

Path Parameters

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

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Amount: number
  Value that identifies the product distribution in amount.
• Item: string
  Maximum Length: 255

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

  Description of the item in the inventory.
• ItemId: integer (int64)
  Value that uniquely identifies the item in the inventory.
• LineNumber: integer (int64)
  Number that indicates the product distribution line.
• Percent: number
  Value that identifies the product distribution in percentage.
• ProgramId: integer (int64)
  Value that uniquely identifies the customer lump-sum program.

{
    "type":"object",
    "properties":{
        "Item":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the item in the inventory.",
            "nullable":true
        },
        "Percent":{
            "type":"number",
            "description":"Value that identifies the product distribution in percentage.",
            "nullable":true,
            "x-queryable":false
        },
        "Amount":{
            "type":"number",
            "description":"Value that identifies the product distribution in amount.",
            "nullable":true,
            "x-queryable":false
        },
        "ProgramId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer lump-sum program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item in the inventory.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ItemDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"Description of the item in the inventory.",
            "nullable":true
        },
        "LineNumber":{
            "type":"integer",
            "description":"Number that indicates the product distribution line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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 : channelCustomerLumpSumPrograms-productDistributions-item-response

Type: object

Show Source

• Amount: number
  Value that identifies the product distribution in amount.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

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

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

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

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

  Maximum Length: 64

  User who most recently updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login of the user who last updated the record.
• LineNumber: integer (int64)
  Number that indicates the product distribution line.
• LineType: string
  Read Only: true

  Maximum Length: 255

  Level at which product distributions are defined. Valid value includes Item. A list of accepted values is defined in the lookup type ORA_CJM_PROG_ITEM_LEVEL.
• LineTypeCode: string
  Read Only: true

  Maximum Length: 30

  Default Value: ORA_ITEM

  Abbreviation that identifies the level at which product distributions are defined.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Percent: number
  Value that identifies the product distribution in percentage.
• ProductDistributionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the product distribution. It's a primary key that the application generates when it creates the product distribution.
• ProgramId: integer (int64)
  Value that uniquely identifies the customer lump-sum program.

{
    "type":"object",
    "properties":{
        "LineTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the level at which product distributions are defined.",
            "nullable":true,
            "readOnly":true,
            "default":"ORA_ITEM",
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Percent":{
            "type":"number",
            "description":"Value that identifies the product distribution in percentage.",
            "nullable":true,
            "x-queryable":false
        },
        "Amount":{
            "type":"number",
            "description":"Value that identifies the product distribution in amount.",
            "nullable":true,
            "x-queryable":false
        },
        "ProductDistributionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the product distribution. It's a primary key that the application generates when it creates the product distribution.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProgramId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer lump-sum program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item in the inventory.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"Description of the item in the inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "LineNumber":{
            "type":"integer",
            "description":"Number that indicates the product distribution line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Item":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the item in the inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LineType":{
            "maxLength":"255",
            "type":"string",
            "description":"Level at which product distributions are defined. Valid value includes Item. A list of accepted values is defined in the lookup type ORA_CJM_PROG_ITEM_LEVEL.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

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

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

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

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

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

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

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

Nested Schema : properties

Type: object

Show Source

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

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

Back to Top