GenOpPlanRequest
Represents a request to generate a service plan.
Each request is stored as record data. We support all delete operations at the record or bulk level. For example, you can use Bulk API 2.0 to delete multiple records in Marketing Cloud Next.
Introduced in API version 62.0.
delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete()
- To access this object, you must have the Service Planner Access add-on license.
-
Type: reference
-
Properties: Filter, Group, Nillable, Sort
-
Relationship name: Agent
-
Relationship type: relationship
-
Refers to: BotDefinition
-
Type: reference
-
Properties: Filter, Group, Nillable, Sort
-
Description:
(Optional) The ID of the Einstein Copilot associated with the plan request.
This field is a relationship field.
-
Relationship name: Copilot
-
Relationship type: relationship
-
Refers to: GenAIPlannerDefinition
- Type: string
- Properties: Filter, Group, Nillable, Sort
- Description: (Optional) The name of the Einstein Copilot associated with the plan request.
- Type: picklist
- Properties: Filter, Group, Nillable, Restricted picklist, Sort
- Description: (Optional) The standard error code when plan generation fails.
- Possible values:
- AgentNotActive — AgentNotActive
- AgentNotFound — AgentNotFound
- CaseGroundingNotEnabled — CaseGroundingNotEnabled
- InstructionsOrActionsNotFound — InstructionsOrActionsNotFound
- InsufficientData — InsufficientData
- InvalidRecordId — InvalidRecordId
- NoEligibilityDefined — NoEligibilityDefined
- NotEligible — NotEligible
- RagConfigurationError — RagConfigurationError
- StepSummaryEmpty — StepSummaryEmpty
- TopicIdNotFound — TopicIdNotFound
- TopicNotFound — TopicNotFound
- Unknown — Unknown
- Type: string
- Properties: Filter, Group, Nillable, Sort
- Description: (Optional) The error message when plan generation fails.
- Type: picklist
- Properties: Filter, Group, Nillable, Restricted picklist, Sort
- Introduced: API version 66.0
- Description: The combined language and locale ISO code, which controls the language of the Generated Operation Plan Request.
- Type: string
- Properties: Filter, Group, Nillable, Sort
- Description: (Optional) The name of the large language model used for plan generation. The maximum length is 80 characters.
- Type: string
- Properties: Filter, Group, Nillable, Sort
- Description: (Optional) The name of the LLM provider. The maximum length is 80 characters.
- Type: string
- Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
- Description: (Required) The auto-generated name of the generated operation plan request.
-
Type: reference
-
Properties: Filter, Group, Sort
-
Description:
(Required) The ID of the service plan parent record.
This field is a polymorphic relationship field.
-
Relationship name: Parent
-
Relationship type: masterdetail
-
Refers to: Case, Opportunity, Incident, MessagingSession, VoiceCall
- Type: string
- Properties: Filter, Group, Nillable, Sort
- Description: (Optional) The developer name of the prompt template used for plan generation. The maximum length is 80 characters.
- Type: int
- Properties: Filter, Group, Nillable, Sort
- Description: (Optional) The version number of the prompt template.
- Type: picklist
- Properties: Defaulted on create, Filter, Group, Restricted picklist, Sort
- Description: (Required) The reason why plan generation failed or returned no steps.
- Possible values:
- CannotGeneratePlan — CannotGeneratePlan
- NoEligibilityConfig — NoEligibilityConfig
- None — None
- NoPlanGenerated — NoPlanGenerated
- PlanEmptyInsufficientData — PlanEmptyInsufficientData
- RagConfigurationError — RagConfigurationError
- ThresholdError — ThresholdError
- ThresholdNotMet — ThresholdNotMet
- Type: picklist
- Properties: Filter, Group, Nillable, Restricted picklist, Sort
- Description: (Optional) The source where the plan request originated.
- Possible values:
- CASE — CASE
- EINSTEIN_LEX — EINSTEIN_LEX
- INCIDENT — INCIDENT
- Type: picklist
- Properties: Defaulted on create, Filter, Group, Restricted picklist, Sort
- Description: (Required) The type of service plan request.
- Possible values:
- Close — Close
- Generation — Generation
- Summary — Summary
- Type: picklist
- Properties: Defaulted on create, Filter, Group, Restricted picklist, Sort
- Description: (Required) The status of the plan generation request.
- Possible values:
- Error — Error
- Incomplete — Incomplete
- InProgress — InProgress
- Success — Success
- Type: textarea
- Properties: Nillable
- Description: (Optional) The natural language input or prompt used for plan generation. The maximum length is 32,000 characters.