Update one lump-sum program

patch

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

Request

Path Parameters
Header Parameters
  • 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".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The Attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Channel Customer Lump-Sum Program Descriptive Flexfields
Type: array
Title: Channel Customer Lump-Sum Program Descriptive Flexfields
The Channel Customer Lump-Sum Program Descriptive Flexfields resource manages additional details for a program.
Show Source
Nested Schema : Notes
Type: array
Title: Notes
The Notes resource is used to view, create, and update notes.
Show Source
Nested Schema : Product Distributions
Type: array
Title: Product Distributions
The Product Distributions resource manages eligible products for a lump-sum program and their amount distribution.
Show Source
Nested Schema : channelCustomerLumpSumPrograms-attachments-item-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : channelCustomerLumpSumPrograms-productDistributions-item-patch-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The Attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Channel Customer Lump-Sum Program Descriptive Flexfields
Type: array
Title: Channel Customer Lump-Sum Program Descriptive Flexfields
The Channel Customer Lump-Sum Program Descriptive Flexfields resource manages additional details for a program.
Show Source
Nested Schema : Notes
Type: array
Title: Notes
The Notes resource is used to view, create, and update notes.
Show Source
Nested Schema : Product Distributions
Type: array
Title: Product Distributions
The Product Distributions resource manages eligible products for a lump-sum program and their amount distribution.
Show Source
Nested Schema : channelCustomerLumpSumPrograms-attachments-item-response
Type: object
Show Source
Nested Schema : channelCustomerLumpSumPrograms-DFF-item-response
Type: object
Show Source
Nested Schema : channelCustomerLumpSumPrograms-notes-item-response
Type: object
Show Source
Nested Schema : channelCustomerLumpSumPrograms-productDistributions-item-response
Type: object
Show Source
Back to Top