Update an enrollment
patch
/crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}
Request
Path Parameters
-
EnrollmentNumber(required): string
The alternate key identifier of the program enrollment.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
EnrollmentStatus: string
Title:
Status
Maximum Length:30
Default Value:DRAFT
The status of the enrollment. The accepted values are draft, pending, approved, rejected, terminated, and renewed. A list of valid values is defined in the lookup ZPM_ENROLLMENT_STATUS. -
ExpirationDate: string
(date)
Title:
End Date
The date when the enrollment expires. -
Notes: array
Notes
Title:
Notes
The notes resource is used to view, create, update, and delete notes associated with a partner program. A note captures comments, information, or instructions related to a partner program. -
PartnerName: string
Title:
Partner
The name of the partner. -
PartnerProgram: array
Partner Programs
Title:
Partner Programs
The partner programs resource is used to view information about the partner programs, such as the name of the program, program description, validity period, and so on. -
PrimaryContactId: number
Title:
Primary Contact ID
The unique identifier of the person to contact for the program enrollments. -
ProgramBenefitDetails: array
Program Benefit Details
Title:
Program Benefit Details
The program benefit details resource is used to view the details of a program benefit. -
smartActions: array
Smart Actions
Title:
Smart Actions
This VO stores the endpoint and security details for every user action. -
StartDate: string
(date)
Title:
Start Date
The effective date when the program enrollment starts. -
SubmissionDate: string
(date)
Title:
Submission Date
The date when the enrollment was submitted.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Notes
Type:
array
Title:
Notes
The notes resource is used to view, create, update, and delete notes associated with a partner program. A note captures comments, information, or instructions related to a partner program.
Show Source
Nested Schema : Partner Programs
Type:
array
Title:
Partner Programs
The partner programs resource is used to view information about the partner programs, such as the name of the program, program description, validity period, and so on.
Show Source
Nested Schema : Program Benefit Details
Type:
array
Title:
Program Benefit Details
The program benefit details resource is used to view the details of a program benefit.
Show Source
Nested Schema : Smart Actions
Type:
array
Title:
Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
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. -
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.
Nested Schema : schema
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
The unique identifier of the relationship populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code of the note associated with the contact. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
The unique party identifier for the note creator. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
NoteTitle: string
Title:
Title
Maximum Length:500
The title of the note entered by the user. -
NoteTxt: string
(byte)
Title:
Note
The actual note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
This code indicating the type of the note. A list of valid values is defined in the lookup ZMM_NOTE_TYPE. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
The primary key identifier of the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, and so on. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
The code indicating the visibility level of the note, such as internal, external or private. A list of valid values is defined in the lookup ZMM_NOTE_VISIBILITY.
Nested Schema : programEnrollments-PartnerProgram-item-patch-request
Type:
Show Source
object
-
EndDateActive: string
(date)
Title:
End Date
The effective data when the program ends. -
ProgramDescription: string
Title:
Description
Maximum Length:1000
The description of the program. -
ProgramManagerId: integer
Title:
Program Manager ID
The unique identifier of the person managing the partner program. -
ProgramManagerName: string
Title:
Owner
Maximum Length:360
The name of the program manager. -
ProgramName: string
Title:
Name
Maximum Length:150
The name of the partner program. -
ProgramType: string
Title:
Type
Maximum Length:30
The type of the partner program. The accepted values are developer, distributor, go to market, technology partner, product focus area, and reseller. A list of accepted values is defined in the lookup ZPM_PARTNER_PROGRAM_TYPE. -
StartDateActive: string
(date)
Title:
Start Date
The effective date when the program starts. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:D
The status of the partner program. The accepted values are draft, pending, published, and terminated.
Nested Schema : programEnrollments-ProgramBenefitDetails-item-patch-request
Type:
Show Source
object
-
BenefitListValue: string
The value of the benefit. The attribute has a value when the Datatype is of type List.
-
BenefitValue: string
Title:
Benefit Value
Maximum Length:150
The value of the benefit. -
TierId: integer
(int64)
Title:
Tier
The unique identifier of the associated tier for the program benefit.
Nested Schema : programEnrollments-smartActions-item-patch-request
Type:
Show Source
object
-
ActionContextParameters: string
Title:
Action Context Parameters
Maximum Length:1000
Determines the context when a smart action is applicable. -
ActionIntent: string
(byte)
Title:
Action Intent
JSON object that describes what an action does and what context data can be passed to the action. -
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Boolean value indicating if the action is active or inactive. -
ApplicationRoles: string
Title:
Application Roles
Maximum Length:2000
The application roles associated with the smart action. -
Condition: string
Title:
Filter Condition
Maximum Length:1000
Groovy script used to qualify this action. -
ConfirmationMessage: string
Title:
Confirmation Message
Maximum Length:4000
A message to seek confirmation for the action being performed. -
ContentType: string
Title:
Content Type
Maximum Length:50
The content type to use when invoking the REST endpoint. -
ContextualFlag: boolean
Title:
Contextual
Maximum Length:1
Indicates if the smart action is contextual. -
DataPrivilege: string
Title:
Data Security Privilege
Maximum Length:250
JSON string containing the Privilege name, the object name, and the object key. -
DisplayLabel: string
Title:
Action Name
Maximum Length:256
Consumer-friendly action name. -
Entity: string
Title:
Parent Entity
Maximum Length:150
REST Resources the action belongs to. -
Href: string
Title:
REST Endpoint
Maximum Length:150
The REST endpoint to perform the action. -
IncludedIn: string
Title:
Included In
Maximum Length:150
The view object this action is part of. Could contain more than one comma-separated value. -
IncludedInApplication: string
Title:
Included in Application
Maximum Length:512
List of applications that this action can be used in. -
InternalFlag: boolean
Title:
Restricted
Maximum Length:1
Boolean type indicating if this action is internal. -
MassActionFlag: boolean
Title:
Mass Action
Maximum Length:1
Boolean type indicating if this action can be mass processed. -
Method: string
Title:
HTTP Method
Maximum Length:15
HTTP method to use with HREF. -
ObjectFunctionName: string
Title:
Object Function
Maximum Length:64
The object function associated with the smart action. -
PageType: string
Title:
Page Type
Maximum Length:256
The list of pages that this action can be used in. -
SmartSuggestFlag: boolean
Title:
Smart Suggest
Maximum Length:1
Indicates if smart suggest is enabled for the action. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Boolean type indicating if the action is seeded or custom. -
UpdateOfAttributes: string
Title:
Attributes to Update
Maximum Length:512
Attributes to be updated when the Actions UI is launched. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
Priority
Number to indicate priority of the action. -
UserActionRequestPayload: array
Smart Action REST Payload Definitions
Title:
Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here. -
UserActionURLBinding: array
Smart Action User Interface Definitions
Title:
Smart Action User Interface Definitions
Binding metadata for a variable in the URL. -
UserPrivilege: string
Title:
User Security Privilege
Maximum Length:4000
The user security privilege.
Nested Schema : Smart Action REST Payload Definitions
Type:
array
Title:
Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type:
array
Title:
Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : programEnrollments-smartActions-UserActionRequestPayload-item-patch-request
Type:
Show Source
object
-
Binding: string
Title:
Payload Value Binding Type
Maximum Length:64
Indicates the binding type of the value. -
MandatoryFlag: boolean
Title:
Mandatory
Maximum Length:1
Boolean value indicating if the payload is mandatory. -
RequestPayloadName: string
Title:
Request Payload Attribute Name
Maximum Length:256
The key in the Key Value pair that forms the payload. -
SmartSuggestPath: string
Title:
Smart Suggest Path
Maximum Length:2048
The path used for smart suggest. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
Boolean value. -
Value: string
Title:
Request Payload Attribute Value
Maximum Length:1000
The value in the Key Value pair that forms the payload. -
ValueStruct: string
Title:
Payload Value Structure
Maximum Length:20
If the value in the Key Value pair isn't a single value, this would be set.
Nested Schema : programEnrollments-smartActions-UserActionURLBinding-item-patch-request
Type:
Show Source
object
-
Binding: string
Title:
URL Binding Type
Maximum Length:64
This is a hint for processing the Url Binding runtime. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
Boolean indicator. -
URLBindingName: string
Title:
URL Binding Parameter Name
Maximum Length:50
For action REST endpoints that require runtime binding, this is the key in the key value pair. -
Value: string
Title:
URL Binding Parameter Value
Maximum Length:80
For action REST endpoints that require runtime binding, this is the value in the key value pair.
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.
Root Schema : programEnrollments-item-response
Type:
Show Source
object
-
ActiveEnrollment: string
Title:
Approved Enrollment State
Read Only:true
The activity status of the enrollment. The accepted values are active and inactive. -
ApprovalDate: string
(date)
Title:
Approval Date
Read Only:true
The date when the enrollment was approved. -
Attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the enrollment record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
EnrollmentNumber: string
Title:
Enrollment Number
Maximum Length:30
The alternate key identifier of the program enrollment. -
EnrollmentStatus: string
Title:
Status
Maximum Length:30
Default Value:DRAFT
The status of the enrollment. The accepted values are draft, pending, approved, rejected, terminated, and renewed. A list of valid values is defined in the lookup ZPM_ENROLLMENT_STATUS. -
ExpirationDate: string
(date)
Title:
End Date
The date when the enrollment expires. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
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. -
Notes: array
Notes
Title:
Notes
The notes resource is used to view, create, update, and delete notes associated with a partner program. A note captures comments, information, or instructions related to a partner program. -
PartnerCompanyNumber: string
Title:
Partner Number
Maximum Length:30
Public Unique Identifier of Partner company associated to the Program Enrollments. -
PartnerName: string
Title:
Partner
The name of the partner. -
PartnerPartyId: number
Title:
Partner
The unique identifier of a partner. -
PartnerPartyName: string
Title:
Partner
Read Only:true
Maximum Length:360
The name of the partner. -
PartnerProgram: array
Partner Programs
Title:
Partner Programs
The partner programs resource is used to view information about the partner programs, such as the name of the program, program description, validity period, and so on. -
PartnerProgramId: number
Title:
Program
The unique identifier of a partner program. -
PartnerTierId: integer
(int64)
Title:
Partner Tier
Read Only:true
The tier of the partner. -
PrimaryContactId: number
Title:
Primary Contact ID
The unique identifier of the person to contact for the program enrollments. -
ProgramAccessable: boolean
Read Only:
true
Indicates whether the partner program can be accessed by the current user. -
ProgramBenefitDetails: array
Program Benefit Details
Title:
Program Benefit Details
The program benefit details resource is used to view the details of a program benefit. -
ProgramDescription: string
Title:
Program Description
Read Only:true
Maximum Length:1000
The description of the program. -
ProgramEnrollmentId: number
Title:
Program Enrollment ID
The unique identifier of a partner program enrollment. -
ProgramName: string
Title:
Program
Maximum Length:150
The name of the partner program. -
ProgramNumber: string
Title:
Program Number
Maximum Length:30
The alternate key identifier of the program. -
RemainingDays: string
Title:
Expiration in Days
Read Only:true
Maximum Length:255
The number of days before the enrollment expires. -
RenewAllowed: boolean
Title:
Renewal Allowed
Read Only:true
Indicates whether the enrollment can transition to renewed status based on its current status. -
RenewedEnrollment: string
Title:
Renewal
Read Only:true
Maximum Length:255
The renewal status of the enrollment. The accepted values are new and renewal. -
RenewedFromEnrollmentNumber: string
Title:
Previous Enrollment Number
Read Only:true
Indicates whether the current enrollment is renewed from the previous enrollment. -
RenewedFromId: number
Title:
RenewedFromEnrollmentId
Read Only:true
The unique identifier of the enrollment from which the renewal enrollment is copied. -
smartActions: array
Smart Actions
Title:
Smart Actions
This VO stores the endpoint and security details for every user action. -
StartDate: string
(date)
Title:
Start Date
The effective date when the program enrollment starts. -
SubmissionDate: string
(date)
Title:
Submission Date
The date when the enrollment was submitted. -
SubmitAllowed: boolean
Title:
Submission Allowed
Read Only:true
Indicates whether the enrollment can transition to pending status based on its current status. -
TerminateAllowed: boolean
Title:
Termination Allowed
Read Only:true
Indicates whether the enrollment can transition to terminated status based on its current status. -
TerminationDate: string
(date)
Title:
Termination Date
Read Only:true
The date when the enrollment terminates. -
WithdrawAllowed: boolean
Title:
Withdrawal Allowed
Read Only:true
Indicates whether the enrollment can transition to withdraw status based on its current status.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Notes
Type:
array
Title:
Notes
The notes resource is used to view, create, update, and delete notes associated with a partner program. A note captures comments, information, or instructions related to a partner program.
Show Source
Nested Schema : Partner Programs
Type:
array
Title:
Partner Programs
The partner programs resource is used to view information about the partner programs, such as the name of the program, program description, validity period, and so on.
Show Source
Nested Schema : Program Benefit Details
Type:
array
Title:
Program Benefit Details
The program benefit details resource is used to view the details of a program benefit.
Show Source
Nested Schema : Smart Actions
Type:
array
Title:
Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : programEnrollments-Attachments-item-response
Type:
Show Source
object
-
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
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : programEnrollments-Notes-item-response
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
The unique identifier of the relationship populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code of the note associated with the contact. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the note record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the note record was created. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
The unique party identifier for the note creator. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
DeleteFlag: boolean
Title:
Delete Indicator
Read Only:true
Indicates whether the note is to be deleted. If the value is Y, then the note has to be deleted. The default value is N. -
EmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The email address of the user who created the note. -
FormattedAddress: string
Title:
Primary Address
Read Only:true
The address of the user who created the note. -
FormattedPhoneNumber: string
Title:
Primary Phone
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 note data was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
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 associated with the contact. 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 actual note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
This code indicating the type of the note. A list of valid values is defined in the lookup ZMM_NOTE_TYPE. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
The unique identifier of the parent note. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
The unique Identifier of the contact to which the note is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the contact record with which the address is associated. -
PartyName: string
Title:
Author
Read Only:true
Maximum Length:360
The name of a contact party. -
SourceObjectCode: string
Title:
Related Object Type
Maximum Length:30
The code indicating the type of the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, and so on. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
The primary key identifier of the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, and so on. -
UpdateFlag: boolean
Title:
Update Indicator
Read Only:true
Indicates whether the note can be updated. If the value is Y, then the note can be updated. The default value is N. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
The code indicating the visibility level of the note, such as internal, external or private. A list of valid values is defined in the lookup ZMM_NOTE_VISIBILITY.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : programEnrollments-PartnerProgram-item-response
Type:
Show Source
object
-
CountryNames: string
Title:
Countries
Read Only:true
The name of the countries for the program. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the program record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the program record was created. -
DeleteFlag: boolean
Read Only:
true
Indicates if the record can be deleted. The default value is false. -
EndDateActive: string
(date)
Title:
End Date
The effective data when the program ends. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the program record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who updated the program record. -
LastUpdateLogin: string
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. -
OwnerPartyNumber: string
Title:
Owner Party Number
Read Only:true
Maximum Length:30
Public Unique Identifier of Owner Party on the Partner Programs. -
PartnerProgramId: integer
Title:
Program ID
The unique Identifier of the partner program associated with the enrollment. This is the primary key of the partnerprogram table. -
ProgramDescription: string
Title:
Description
Maximum Length:1000
The description of the program. -
ProgramManagerId: integer
Title:
Program Manager ID
The unique identifier of the person managing the partner program. -
ProgramManagerName: string
Title:
Owner
Maximum Length:360
The name of the program manager. -
ProgramName: string
Title:
Name
Maximum Length:150
The name of the partner program. -
ProgramNumber: string
Title:
Program Number
Maximum Length:30
The unique number generated for the program. -
ProgramType: string
Title:
Type
Maximum Length:30
The type of the partner program. The accepted values are developer, distributor, go to market, technology partner, product focus area, and reseller. A list of accepted values is defined in the lookup ZPM_PARTNER_PROGRAM_TYPE. -
ProgramTypeMeaning: string
Title:
Type
Read Only:true
Maximum Length:80
The type of the partner program. The accepted values are developer, distributor, go to market, technology partner, product focus area, and reseller. A list of accepted values is defined in the lookup ZPM_PARTNER_PROGRAM_TYPE. -
StartDateActive: string
(date)
Title:
Start Date
The effective date when the program starts. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:D
The status of the partner program. The accepted values are draft, pending, published, and terminated. -
UpdateFlag: boolean
Read Only:
true
Indicates if the record can be updated. The default value is false.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : programEnrollments-ProgramBenefitDetails-item-response
Type:
Show Source
object
-
BenefitListValue: string
The value of the benefit. The attribute has a value when the Datatype is of type List.
-
BenefitValue: string
Title:
Benefit Value
Maximum Length:150
The value of the benefit. -
CategoryCode: string
Title:
Category
Read Only:true
Maximum Length:30
The code indicating the category of the benefit. For example, Financial, Sales, Technical Support, and so on. A list of valid values is defined in the lookup ORA_ZPM_BENEFIT_CATEGORY. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The date and time when the record was last updated. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The user who last created the record. -
DataType: string
Title:
Value Type
Read Only:true
Maximum Length:30
The value type of the benefit. For example, Amount, List, Number, Text, Yes/No. -
DeleteFlag: boolean
Read Only:
true
Indicates if the record can be deleted. The default value is false. -
Description: string
Title:
Benefits Description
Read Only:true
Maximum Length:1000
The text describing the benefit. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the program benefit detail. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:155
The name of the benefit. -
PartnerProgramId: integer
(int64)
Title:
Program
The identifier of the partner program associated with the enrollment. -
ProgramBenefitDetailId: integer
Title:
Program Benefit Details
The unique identifier of the program benefit details. -
ProgramBenefitId: integer
(int64)
Title:
Benefit
The unique identifier of the program benefit. -
TierId: integer
(int64)
Title:
Tier
The unique identifier of the associated tier for the program benefit. -
TierName: string
Title:
Name
Read Only:true
Maximum Length:155
The name of the tier associated with the benefit. -
UpdateFlag: boolean
Read Only:
true
Indicates if the record can be updated. The default value is false.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : programEnrollments-smartActions-item-response
Type:
Show Source
object
-
ActionContextParameters: string
Title:
Action Context Parameters
Maximum Length:1000
Determines the context when a smart action is applicable. -
ActionIntent: string
(byte)
Title:
Action Intent
JSON object that describes what an action does and what context data can be passed to the action. -
ActionSource: string
Title:
Action Source
Maximum Length:512
Attribute that describes the source of a smart action. Smart actions can be manually created or cloned, or automatically generated. -
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Boolean value indicating if the action is active or inactive. -
ApplicationRoles: string
Title:
Application Roles
Maximum Length:2000
The application roles associated with the smart action. -
Condition: string
Title:
Filter Condition
Maximum Length:1000
Groovy script used to qualify this action. -
ConfirmationMessage: string
Title:
Confirmation Message
Maximum Length:4000
A message to seek confirmation for the action being performed. -
ContentType: string
Title:
Content Type
Maximum Length:50
The content type to use when invoking the REST endpoint. -
ContextualFlag: boolean
Title:
Contextual
Maximum Length:1
Indicates if the smart action is contextual. -
DataPrivilege: string
Title:
Data Security Privilege
Maximum Length:250
JSON string containing the Privilege name, the object name, and the object key. -
DisplayLabel: string
Title:
Action Name
Maximum Length:256
Consumer-friendly action name. -
Entity: string
Title:
Parent Entity
Maximum Length:150
REST Resources the action belongs to. -
Href: string
Title:
REST Endpoint
Maximum Length:150
The REST endpoint to perform the action. -
IncludedIn: string
Title:
Included In
Maximum Length:150
The view object this action is part of. Could contain more than one comma-separated value. -
IncludedInApplication: string
Title:
Included in Application
Maximum Length:512
List of applications that this action can be used in. -
InternalFlag: boolean
Title:
Restricted
Maximum Length:1
Boolean type indicating if this action is internal. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MassActionFlag: boolean
Title:
Mass Action
Maximum Length:1
Boolean type indicating if this action can be mass processed. -
Method: string
Title:
HTTP Method
Maximum Length:15
HTTP method to use with HREF. -
ObjectFunctionName: string
Title:
Object Function
Maximum Length:64
The object function associated with the smart action. -
PageType: string
Title:
Page Type
Maximum Length:256
The list of pages that this action can be used in. -
SmartSuggestFlag: boolean
Title:
Smart Suggest
Maximum Length:1
Indicates if smart suggest is enabled for the action. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Boolean type indicating if the action is seeded or custom. -
UpdateOfAttributes: string
Title:
Attributes to Update
Maximum Length:512
Attributes to be updated when the Actions UI is launched. -
UserActionId: integer
(int64)
Title:
User Action ID
Uniquely identifies the action. For internal use. -
UserActionName: string
Title:
Action Name
Maximum Length:256
Uniquely identifies the action with a name. For internal use. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
Priority
Number to indicate priority of the action. -
UserActionRequestPayload: array
Smart Action REST Payload Definitions
Title:
Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here. -
UserActionURLBinding: array
Smart Action User Interface Definitions
Title:
Smart Action User Interface Definitions
Binding metadata for a variable in the URL. -
UserPrivilege: string
Title:
User Security Privilege
Maximum Length:4000
The user security privilege.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type:
array
Title:
Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type:
array
Title:
Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : programEnrollments-smartActions-UserActionRequestPayload-item-response
Type:
Show Source
object
-
Binding: string
Title:
Payload Value Binding Type
Maximum Length:64
Indicates the binding type of the value. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MandatoryFlag: boolean
Title:
Mandatory
Maximum Length:1
Boolean value indicating if the payload is mandatory. -
RequestPayloadId: integer
(int64)
Uniquely identifies the payload for smart actions. For internal use.
-
RequestPayloadName: string
Title:
Request Payload Attribute Name
Maximum Length:256
The key in the Key Value pair that forms the payload. -
SmartSuggestPath: string
Title:
Smart Suggest Path
Maximum Length:2048
The path used for smart suggest. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
Boolean value. -
Value: string
Title:
Request Payload Attribute Value
Maximum Length:1000
The value in the Key Value pair that forms the payload. -
ValueStruct: string
Title:
Payload Value Structure
Maximum Length:20
If the value in the Key Value pair isn't a single value, this would be set.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : programEnrollments-smartActions-UserActionURLBinding-item-response
Type:
Show Source
object
-
Binding: string
Title:
URL Binding Type
Maximum Length:64
This is a hint for processing the Url Binding runtime. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
Boolean indicator. -
URLBindingId: integer
(int64)
Uniquely identifies the URL Bind for smart actions. For internal use.
-
URLBindingName: string
Title:
URL Binding Parameter Name
Maximum Length:50
For action REST endpoints that require runtime binding, this is the key in the key value pair. -
Value: string
Title:
URL Binding Parameter Value
Maximum Length:80
For action REST endpoints that require runtime binding, this is the value in the key value pair.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- Attachments
-
Operation: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/AttachmentsParameters:
- EnrollmentNumber:
$request.path.EnrollmentNumber
The attachments resource is used to view, create, and update attachments. - EnrollmentNumber:
- EnrollmentStatusLookup
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZPM_ENROLLMENT_STATUS%2CBindLookupCode%3D{EnrollmentStatus}
The list of values for the enrollment status such as Draft, Pending, Approved, Rejected, Terminated, Expired, and Renewed.
The following properties are defined on the LOV link relation:- Source Attribute: EnrollmentStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- Notes
-
Parameters:
- EnrollmentNumber:
$request.path.EnrollmentNumber
The notes resource is used to view, create, update, and delete notes associated with a partner program. A note captures comments, information, or instructions related to a partner program. - EnrollmentNumber:
- PartnerPickerVA
-
Operation: /crmRestApi/resources/11.13.18.05/partnersParameters:
- finder:
CompanyNumberRF
The list of values for partner name, such as Anexis Systems, as created previously by user.
The following properties are defined on the LOV link relation:- Source Attribute: PartnerName; Target Attribute: PartyName
- Display Attribute: PartyName
- finder:
- PartnerProgram
-
Operation: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/PartnerProgramParameters:
- EnrollmentNumber:
$request.path.EnrollmentNumber
The partner programs resource is used to view information about the partner programs, such as the name of the program, program description, validity period, and so on. - EnrollmentNumber:
- PartnerProgramLookup
-
The list of values for the partner program, such as North American Reseller Program, as created previously by user.
The following properties are defined on the LOV link relation:- Source Attribute: ProgramName; Target Attribute: ProgramName
- Display Attribute: ProgramName, ProgramTypeMeaning, StartDateActive, EndDateActive
- ProgramBenefitDetails
-
Operation: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/ProgramBenefitDetailsParameters:
- EnrollmentNumber:
$request.path.EnrollmentNumber
The program benefit details resource is used to view the details of a program benefit. - EnrollmentNumber:
- Tiers
-
The value of the selected partner's tier, such as Platinum, Gold, or Silver, as assigned to the partner previously by user.
The following properties are defined on the LOV link relation:- Source Attribute: PartnerTierId; Target Attribute: TierId
- Display Attribute: Name
- smartActions
-
Operation: /crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/child/smartActionsParameters:
- EnrollmentNumber:
$request.path.EnrollmentNumber
This VO stores the endpoint and security details for every user action. - EnrollmentNumber:
Examples
The following example shows how to update an enrollment by submitting a patch request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X PATCH https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/programEnrollments/ENRM_12345/
Example of Request Body
The following shows an example of the request body in JSON format.
{ "EnrollmentStatus": "RENEWED", "ExpirationDate": "2014-06-28" }
Example of Response Body
The following shows an example of the response body in JSON format.
{ ... CreationDate: "2011-06-28T08:48:27-07:00" EnrollmentNumber: "ENRM_12345" EnrollmentStatus: "RENEWED" LastUpdateDate: "2015-06-29T02:32:16-07:00" LastUpdatedBy: "CHANNEL_OPERATIONS_MANAGER" PartnerPartyId: 100000016934014 PartnerProgramId: 100000020251181 ProgramEnrollmentId: 300100000521703 ApprovalDate: "2011-06-28" ExpirationDate: "2014-06-28" TerminationDate: null StartDate: "2011-06-28" RenewedFromId: null RemainingDays: "" ... ActiveEnrollment: "INACTIVE" RenewedEnrollment: "NEW" ... -links: [7] -0 { ... } -1 { ... } ... }