Update an orchestration
patch
/crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}
Request
Path Parameters
-
OrchestrationNumber(required): string
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=
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
-
ActivationDateTime: string
(date-time)
Title:
Activation Date Time
The date and time when the orchestration is activated. -
ActivityRelationshipAttrName: string
Title:
Activity Relationship
Maximum Length:100
The custom object primary key field name on the activity object for orchestration. It's used to stamp the custom object identifier when the activity is being generated. -
AssociationCriteriaExpression: string
(byte)
Title:
Association Criteria Expression
The criteria expression, in JSON format, used to associate orchestration objects to transactional objects. -
AssociationRank: integer
Title:
Association Rank
The rank in which the orchestrations need to be processed during association. -
ErrorLogs: array
Error Logs
Title:
Error Logs
The error logs resource is used to view the error details. -
ImportedDateTime: string
(date-time)
Title:
Import Date Time
The date and time when the orchestration was last imported from a different environment. -
ObjectCode: string
Title:
Object Code
Maximum Length:100
The language independent code for the current row of the orchestrations object. -
OrchestrationDescription: string
Title:
Orchestration Description
Maximum Length:2000
The description text of the orchestration object. -
OrchestrationName: string
Title:
Orchestration Name
Maximum Length:100
The name of the orchestration. -
OrchestrationType: string
Title:
Orchestration Type
Maximum Length:30
The type of orchestration. The values are guided selling, program builder, and so on. -
PerformAction: string
Maximum Length:
100
Indicates the action that can be performed on the orchestration. -
SimulationCriteriaExpression: string
(byte)
Title:
Simulation Criteria Expression
Criteria expression (in JSON format) used to simulate Orchestration against transactional objects. -
SourceOrchestrationId: integer
(int64)
Title:
Source Orchestration ID
The identifier of the copied source orchestration when the current orchestration row is copied. -
Stages: array
Stages
Title:
Stages
The stages resource is used to view, create, update, and delete an orchestration stage. The stages are a collection of steps, objectives, and associations. -
StatusCode: string
Title:
Status Code
Maximum Length:30
The status of the orchestration object. Possible values are DRAFT, ACTIVE, and ARCHIVED.
Nested Schema : Error Logs
Type:
array
Title:
Error Logs
The error logs resource is used to view the error details.
Show Source
Nested Schema : Stages
Type:
array
Title:
Stages
The stages resource is used to view, create, update, and delete an orchestration stage. The stages are a collection of steps, objectives, and associations.
Show Source
Nested Schema : orchestrations-ErrorLogs-item-patch-request
Type:
Show Source
object
-
ErrorDescription: string
(byte)
Title:
Error Description
The description of the error. -
ErrorText: string
Title:
Error Text
Maximum Length:2000
Specifies the error call stack. -
OrchestrationAssociationId: integer
(int64)
Title:
Orchestration Association ID
The unique identifier of the orchestration association. -
OrchestrationStepId: integer
(int64)
Title:
Orchestration Step ID
The unique identifier of the orchestration steps object. -
SourceObjectCode: string
Title:
Source Object Code
Maximum Length:100
The language independent code of the transactional object. For example, Lead or Opportunity. -
SourceObjectId: integer
(int64)
Title:
Source Object ID
The unique identifier of the source object.
Nested Schema : schema
Type:
Show Source
object
-
ContainErrorsFlag: boolean
Title:
Contain Errors
Maximum Length:1
Indicates whether the orchestration stage contains any validation errors. -
DisplaySequence: integer
(int32)
Title:
Display Sequence
The order of the orchestration stages in the orchestration administrator run time user interfaces. -
StageDescription: string
Title:
Objective Description
Maximum Length:2000
The description text of the orchestration stage object. -
StageName: string
Title:
Stage Name
Maximum Length:100
The name of the orchestration stage. -
StageObjectives: array
Stage Objectives
Title:
Stage Objectives
The stage objectives resource is used to view, create, update, and delete a stage objective. It's a free form of goals to achieve in a particular stage. -
StepObjectivesAssociations: array
Step Objective Associations
Title:
Step Objective Associations
The step objective associations resource is used to view, create, update, and delete a step objective association. It's the objective of performing a step. One step can be mapped to multiple objectives. -
Steps: array
Steps
Title:
Steps
The steps resource is used to view, create, update, and delete a step. Steps are individual action items such as execute a smart action, send an email, make a phone call, and so on. -
StepTasks: array
Step Tasks
Title:
Step Tasks
Step tasks contains the list of tasks and their related information for a given step.
Nested Schema : Stage Objectives
Type:
array
Title:
Stage Objectives
The stage objectives resource is used to view, create, update, and delete a stage objective. It's a free form of goals to achieve in a particular stage.
Show Source
Nested Schema : Step Objective Associations
Type:
array
Title:
Step Objective Associations
The step objective associations resource is used to view, create, update, and delete a step objective association. It's the objective of performing a step. One step can be mapped to multiple objectives.
Show Source
Nested Schema : Steps
Type:
array
Title:
Steps
The steps resource is used to view, create, update, and delete a step. Steps are individual action items such as execute a smart action, send an email, make a phone call, and so on.
Show Source
Nested Schema : Step Tasks
Type:
array
Title:
Step Tasks
Step tasks contains the list of tasks and their related information for a given step.
Show Source
Nested Schema : orchestrations-Stages-StageObjectives-item-patch-request
Type:
Show Source
object
-
DisplaySequence: integer
(int32)
Title:
Display Sequence
The order of the objectives in the orchestration administrator runtime user interface. -
ObjectiveDescription: string
Title:
Objective Description
Maximum Length:2000
The description text of the orchestration stage objective object. -
ObjectiveName: string
Title:
Objective Name
Maximum Length:100
The name of the orchestration stage objective object. -
ObjectiveStatus: string
Title:
Objective Status
Maximum Length:30
The status of the objective. Possible values are NEW or MAPPED.
Nested Schema : orchestrations-Stages-StepObjectivesAssociations-item-patch-request
Type:
Show Source
object
Nested Schema : orchestrations-Stages-Steps-item-patch-request
Type:
Show Source
object
-
ActivityTemplateId: integer
(int64)
Title:
Activity Template ID
The identifier for the Task and Appointment templates. -
AllowSkipFlag: boolean
Title:
Allow Step Skipping
Maximum Length:1
Default Value:true
Indicates whether or not to show skip or thumbs down icon in the guidance primary or secondary banner. -
DaysToWait: integer
(int32)
Title:
Days to Wait
Default Value:0
Specifies the number of days to wait. -
DisplaySequence: integer
Title:
Display Sequence
The order of the steps in the orchestration administrator runtime UIs. -
EmailContactsFilterCriteria: string
(byte)
Title:
Email Contacts Filter Criteria
The criteria expression to filter the email contacts. -
EmailContsObjectCd: string
Title:
Email Contact Filter Object
Maximum Length:1000
Specifies the object,emailField and dneField names on which the email contacts criteria is built. -
EmailTemplateId: integer
(int64)
Title:
Email Template ID
The unique identifier of the email template that will be defaulted at run time. -
EvaluateOnMarkCompleteFlag: boolean
Title:
Evaluate on Marked as Completed
Maximum Length:1
Default Value:false
Indicates whether or not to evaluate the success criteria when a task or an appointment is marked as complete. -
ExecutionMethod: string
Title:
Execution Method
Maximum Length:30
The execution type for the orchestration step. The possible values are Manual and Automatic. -
ExitOrchestrationFlag: boolean
Title:
Exit Orchestration
Maximum Length:1
Flag that indicates whether or not to exit the orchestration when a stop step occurs. -
FailureStepId: integer
(int64)
Title:
Failure Step ID
The unique identifier of the next step if the current step fails. -
FailureStepNumber: string
Title:
Orchestration Step Number
Maximum Length:64
The public unique identifier of the orchestration steps object. -
FieldUpdateJson: string
(byte)
Title:
Field Update JSON
The JSON structure containing the list of fields to update on source object. -
GracePeriod: integer
Title:
Grace Period
Specifies the number of hours to wait before treating the Step as failed. This is applicable only for manual steps. -
HoursToWait: integer
Title:
Hours to Wait
Default Value:0
The number of hours to wait. -
IATemplateValue: string
Title:
IA Template Value
Maximum Length:100
The name of the intelligent advisor guide template. -
NextStageValue: string
Title:
Next Stage Value
Maximum Length:100
The value of the Stage to which you need to progress. -
OrchestrationStepName: string
Title:
Orchestration Step Name
Maximum Length:100
The name of orchestration step. -
PreStepCondition: string
(byte)
Title:
Prestep Condition
The condition that gets executed prior to executing the orchestration step. -
SMARTActionId: integer
(int64)
Title:
Smart Action ID
The unique identifier of the smart action. -
StepSuggestionText: string
Title:
Step Suggestion Text
Maximum Length:2000
The suggestion text of the orchestration step. -
StepType: string
Title:
Step Type
Maximum Length:30
Step Type -
SuccessCriteria: string
(byte)
Title:
Success Criteria
The criteria used to identify whether a step is successful. -
SuccessStepId: integer
(int64)
Title:
Success Step ID
The unique identifier of the next step if current step succeeds. -
SuccessStepNumber: string
Title:
Orchestration Step Number
Maximum Length:64
The public unique identifier of the orchestration steps object. -
WaitForRepliesFlag: boolean
Title:
Wait for Replies Flag
Maximum Length:1
Default Value:false
Indicates whether the step has to wait for replies.
Nested Schema : schema
Type:
Show Source
object
-
AllowSkipFlag: boolean
Title:
Allow Step Skipping
Maximum Length:1
Default Value:true
Indicates whether or not to show skip or thumbs down icon in the guidance primary or secondary banner. -
AssignedTo: string
Title:
Assigned To
Maximum Length:30
Default Value:OWNER
Indicates to whom the activity should be assigned to when it's generated. Possible values are OWNER, TEAM MEMBER, and CUSTOM CONDITION. -
AssignedToRule: string
(byte)
Title:
Assigned to Rule
The rule when AssignedTo is specified as CUSTOM_CONDITION. -
DisplaySequence: integer
(int32)
Title:
Display Sequence
The order of the steps in the orchestration administrator runtime UIs. -
EmailTemplateId: integer
(int64)
Title:
Email Template ID
The unique identifier of the email template that will be defaulted at run time. -
EvaluateOnMarkCompleteFlag: boolean
Title:
Evaluate on Marked as Completed
Maximum Length:1
Default Value:false
Indicates whether or not to evaluate the success criteria when a task or an appointment is marked as complete. -
FieldUpdateJson: string
(byte)
Title:
Field Update JSON
The JSON structure containing the list of fields to update on source object. -
GracePeriod: integer
Title:
Grace Period
Specifies the number of hours to wait before treating the Step as failed. This is applicable only for manual steps. -
IATemplateValue: string
Title:
IA Template Value
Maximum Length:100
The name of the intelligent advisor guide template. -
SMARTActionId: integer
(int64)
Title:
Smart Action ID
The unique identifier of the smart action. -
WaitForRepliesFlag: boolean
Title:
Wait for Replies Flag
Maximum Length:1
Default Value:false
Indicates whether the step has to wait for replies.
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 : orchestrations-item-response
Type:
Show Source
object
-
ActivationDateTime: string
(date-time)
Title:
Activation Date Time
The date and time when the orchestration is activated. -
ActivityRelationshipAttrName: string
Title:
Activity Relationship
Maximum Length:100
The custom object primary key field name on the activity object for orchestration. It's used to stamp the custom object identifier when the activity is being generated. -
AssociationCriteriaExpression: string
(byte)
Title:
Association Criteria Expression
The criteria expression, in JSON format, used to associate orchestration objects to transactional objects. -
AssociationRank: integer
Title:
Association Rank
The rank in which the orchestrations need to be processed during association. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
DeleteFlag: boolean
Read Only:
true
Indicates whether the orchestration can be deleted. The value is true for orchestrations in Draft status. -
ErrorLogs: array
Error Logs
Title:
Error Logs
The error logs resource is used to view the error details. -
ImportedDateTime: string
(date-time)
Title:
Import Date Time
The date and time when the orchestration was last imported from a different environment. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the row. -
LifecycleAttributeDisplayLabel: string
Title:
Lifecycle Attribute
Maximum Length:1000
The display label for the lifecycle attribute from the source object view definition. -
LifecycleAttributeName: string
Title:
Lifecycle Attribute Name
Maximum Length:100
The name of the lifecycle attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectCode: string
Title:
Object Code
Maximum Length:100
The language independent code for the current row of the orchestrations object. -
OrchestrationDescription: string
Title:
Orchestration Description
Maximum Length:2000
The description text of the orchestration object. -
OrchestrationId: integer
(int64)
Title:
Orchestration ID
The unique identifier of the orchestration. -
OrchestrationName: string
Title:
Orchestration Name
Maximum Length:100
The name of the orchestration. -
OrchestrationNumber: string
Title:
Orchestration Number
Maximum Length:64
The public unique identifier of the orchestration. -
OrchestrationType: string
Title:
Orchestration Type
Maximum Length:30
The type of orchestration. The values are guided selling, program builder, and so on. -
PerformAction: string
Maximum Length:
100
Indicates the action that can be performed on the orchestration. -
SimulationCriteriaExpression: string
(byte)
Title:
Simulation Criteria Expression
Criteria expression (in JSON format) used to simulate Orchestration against transactional objects. -
SourceOrchestrationId: integer
(int64)
Title:
Source Orchestration ID
The identifier of the copied source orchestration when the current orchestration row is copied. -
Stages: array
Stages
Title:
Stages
The stages resource is used to view, create, update, and delete an orchestration stage. The stages are a collection of steps, objectives, and associations. -
StatusCode: string
Title:
Status Code
Maximum Length:30
The status of the orchestration object. Possible values are DRAFT, ACTIVE, and ARCHIVED. -
StripingAttributeDisplayLabel: string
Title:
Striping Attribute
Maximum Length:1000
The display label for the striping attribute from the source object view definition. -
StripingAttributeName: string
Title:
Striping Attribute Name
Maximum Length:100
The striping attribute name. The striping attribute name determines which orchestration process will be used. -
StripingAttributeValue: string
Title:
Striping Attribute Value
Maximum Length:2000
The striping attribute value in JSON format. -
SyncStagesRequiredFlag: boolean
Read Only:
true
Maximum Length:1
Indicates if the orchestration stages need to be updated. -
UpdateFlag: boolean
Read Only:
true
Indicates whether the orchestration can be updated. The value is true for orchestrations in Draft status.
Nested Schema : Error Logs
Type:
array
Title:
Error Logs
The error logs resource is used to view the error details.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Stages
Type:
array
Title:
Stages
The stages resource is used to view, create, update, and delete an orchestration stage. The stages are a collection of steps, objectives, and associations.
Show Source
Nested Schema : orchestrations-ErrorLogs-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
ErrorDescription: string
(byte)
Title:
Error Description
The description of the error. -
ErrorLogsId: integer
(int64)
Title:
Error Logs ID
The unique identifier of the orchestration error logs. -
ErrorLogsNumber: string
Title:
Error Logs Number
Maximum Length:64
The public unique identifier or alternate key of the orchestration error log. -
ErrorText: string
Title:
Error Text
Maximum Length:2000
Specifies the error call stack. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrchestrationAssociationId: integer
(int64)
Title:
Orchestration Association ID
The unique identifier of the orchestration association. -
OrchestrationId: integer
(int64)
Title:
Orchestration ID
The unique identifier of the orchestration. -
OrchestrationName: string
Title:
Orchestration Name
Read Only:true
Maximum Length:100
The name of the orchestration. -
OrchestrationNumber: string
Title:
Orchestration Number
Read Only:true
Maximum Length:64
The public unique identifier of the orchestration. -
OrchestrationStageId: integer
(int64)
Title:
Orchestration Stage ID
The unique identifier of the orchestration stage object. -
OrchestrationStageName: string
Title:
Stage Name
Read Only:true
Maximum Length:100
The name of the orchestration stage. -
OrchestrationStageNumber: string
Title:
Orchestration Stage Number
Read Only:true
Maximum Length:64
The public unique identifier of the orchestration stage object. -
OrchestrationStepId: integer
(int64)
Title:
Orchestration Step ID
The unique identifier of the orchestration steps object. -
OrchestrationStepName: string
Title:
Orchestration Step Name
Read Only:true
Maximum Length:100
The name of orchestration step. -
OrchestrationStepNumber: string
Title:
Orchestration Step Number
Read Only:true
Maximum Length:64
The public unique identifier of the orchestration steps object. -
SourceObjectCode: string
Title:
Source Object Code
Maximum Length:100
The language independent code of the transactional object. For example, Lead or Opportunity. -
SourceObjectId: integer
(int64)
Title:
Source Object ID
The unique identifier of the source object.
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 : orchestrations-Stages-item-response
Type:
Show Source
object
-
ContainErrorsFlag: boolean
Title:
Contain Errors
Maximum Length:1
Indicates whether the orchestration stage contains any validation errors. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
DisplaySequence: integer
(int32)
Title:
Display Sequence
The order of the orchestration stages in the orchestration administrator run time user interfaces. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrchestrationId: integer
(int64)
Title:
Orchestration ID
The unique identifier of the orchestration. -
OrchestrationName: string
Title:
Orchestration Name
Read Only:true
Maximum Length:100
The name of the orchestration. -
OrchestrationNumber: string
Title:
Orchestration Number
Read Only:true
Maximum Length:64
The public unique identifier of the orchestration. -
OrchestrationStageId: integer
(int64)
Title:
Orchestration Stage ID
The unique identifier of the orchestration stage object. -
OrchestrationStageNumber: string
Title:
Orchestration Stage Number
Maximum Length:64
The public unique identifier of the orchestration stage object. -
StageDescription: string
Title:
Objective Description
Maximum Length:2000
The description text of the orchestration stage object. -
StageName: string
Title:
Stage Name
Maximum Length:100
The name of the orchestration stage. -
StageObjectives: array
Stage Objectives
Title:
Stage Objectives
The stage objectives resource is used to view, create, update, and delete a stage objective. It's a free form of goals to achieve in a particular stage. -
StepObjectivesAssociations: array
Step Objective Associations
Title:
Step Objective Associations
The step objective associations resource is used to view, create, update, and delete a step objective association. It's the objective of performing a step. One step can be mapped to multiple objectives. -
Steps: array
Steps
Title:
Steps
The steps resource is used to view, create, update, and delete a step. Steps are individual action items such as execute a smart action, send an email, make a phone call, and so on. -
StepTasks: array
Step Tasks
Title:
Step Tasks
Step tasks contains the list of tasks and their related information for a given step.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Stage Objectives
Type:
array
Title:
Stage Objectives
The stage objectives resource is used to view, create, update, and delete a stage objective. It's a free form of goals to achieve in a particular stage.
Show Source
Nested Schema : Step Objective Associations
Type:
array
Title:
Step Objective Associations
The step objective associations resource is used to view, create, update, and delete a step objective association. It's the objective of performing a step. One step can be mapped to multiple objectives.
Show Source
Nested Schema : Steps
Type:
array
Title:
Steps
The steps resource is used to view, create, update, and delete a step. Steps are individual action items such as execute a smart action, send an email, make a phone call, and so on.
Show Source
Nested Schema : Step Tasks
Type:
array
Title:
Step Tasks
Step tasks contains the list of tasks and their related information for a given step.
Show Source
Nested Schema : orchestrations-Stages-StageObjectives-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
DisplaySequence: integer
(int32)
Title:
Display Sequence
The order of the objectives in the orchestration administrator runtime user interface. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectiveDescription: string
Title:
Objective Description
Maximum Length:2000
The description text of the orchestration stage objective object. -
ObjectiveName: string
Title:
Objective Name
Maximum Length:100
The name of the orchestration stage objective object. -
ObjectiveStatus: string
Title:
Objective Status
Maximum Length:30
The status of the objective. Possible values are NEW or MAPPED. -
OrchestrationStageId: integer
(int64)
Title:
Orchestration Stage ID
The unique identifier of the orchestrations stage object. -
OrchestrationStageName: string
Title:
Stage Name
Read Only:true
Maximum Length:100
The name of the orchestration stage. -
OrchestrationStageNumber: string
Title:
Orchestration Stage Number
Read Only:true
Maximum Length:64
The public unique identifier of the orchestration stage object. -
StageObjectiveId: integer
(int64)
Title:
Stage Objective ID
The unique identifier of the Orchestration stage objective object. -
StageObjectiveNumber: string
Title:
Stage Objective Number
Maximum Length:64
The public unique identifier of the orchestration stage objective object.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : orchestrations-Stages-StepObjectivesAssociations-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrchestrationStageId: integer
(int64)
Title:
Orchestration Stage ID
The unique identifier of the orchestration stage object. -
OrchestrationStageName: string
Title:
Stage Name
Read Only:true
Maximum Length:100
The name of the orchestration stage. -
OrchestrationStageNumber: string
Title:
Orchestration Stage Number
Read Only:true
Maximum Length:64
The public unique identifier of the orchestration stage object. -
OrchestrationStageObjectiveId: integer
Title:
Stage Objective ID
The unique identifier of the Orchestration stage objective object. -
OrchestrationStepId: integer
Title:
Orchestration Step ID
The unique identifier of the orchestration steps object. -
OrchestrationStepName: string
Title:
Orchestration Step Name
Read Only:true
Maximum Length:100
The name of orchestration step. -
OrchestrationStepNumber: string
Title:
Orchestration Step Number
Maximum Length:64
The public unique identifier of the orchestration steps object. -
StageObjectiveName: string
Title:
Objective Name
Read Only:true
Maximum Length:100
The name of the orchestration stage objective object. -
StageObjectiveNumber: string
Title:
Stage Objective Number
Maximum Length:64
The public unique identifier of the orchestration stage objective object. -
StepObjectiveAssocId: integer
(int64)
Title:
Step Objective Association ID
The unique identifier of the orchestration step objectives association object. -
StepObjectiveAssocNumber: string
Title:
Step Objective Association Number
Maximum Length:64
The public unique identifier of the orchestration step objectives association object.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : orchestrations-Stages-Steps-item-response
Type:
Show Source
object
-
ActivityTemplateId: integer
(int64)
Title:
Activity Template ID
The identifier for the Task and Appointment templates. -
AllowSkipFlag: boolean
Title:
Allow Step Skipping
Maximum Length:1
Default Value:true
Indicates whether or not to show skip or thumbs down icon in the guidance primary or secondary banner. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
DaysToWait: integer
(int32)
Title:
Days to Wait
Default Value:0
Specifies the number of days to wait. -
DisplaySequence: integer
Title:
Display Sequence
The order of the steps in the orchestration administrator runtime UIs. -
EmailContactsFilterCriteria: string
(byte)
Title:
Email Contacts Filter Criteria
The criteria expression to filter the email contacts. -
EmailContsObjectCd: string
Title:
Email Contact Filter Object
Maximum Length:1000
Specifies the object,emailField and dneField names on which the email contacts criteria is built. -
EmailTemplateId: integer
(int64)
Title:
Email Template ID
The unique identifier of the email template that will be defaulted at run time. -
EvaluateOnMarkCompleteFlag: boolean
Title:
Evaluate on Marked as Completed
Maximum Length:1
Default Value:false
Indicates whether or not to evaluate the success criteria when a task or an appointment is marked as complete. -
ExecutionMethod: string
Title:
Execution Method
Maximum Length:30
The execution type for the orchestration step. The possible values are Manual and Automatic. -
ExitOrchestrationFlag: boolean
Title:
Exit Orchestration
Maximum Length:1
Flag that indicates whether or not to exit the orchestration when a stop step occurs. -
FailureStepId: integer
(int64)
Title:
Failure Step ID
The unique identifier of the next step if the current step fails. -
FailureStepName: string
Title:
Orchestration Step Name
Read Only:true
Maximum Length:100
The name of orchestration step. -
FailureStepNumber: string
Title:
Orchestration Step Number
Maximum Length:64
The public unique identifier of the orchestration steps object. -
FieldUpdateJson: string
(byte)
Title:
Field Update JSON
The JSON structure containing the list of fields to update on source object. -
GracePeriod: integer
Title:
Grace Period
Specifies the number of hours to wait before treating the Step as failed. This is applicable only for manual steps. -
HoursToWait: integer
Title:
Hours to Wait
Default Value:0
The number of hours to wait. -
IATemplateValue: string
Title:
IA Template Value
Maximum Length:100
The name of the intelligent advisor guide template. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NextStageValue: string
Title:
Next Stage Value
Maximum Length:100
The value of the Stage to which you need to progress. -
OrchestrationStageId: integer
(int64)
Title:
Orchestration Stage ID
The unique identifier of the orchestrations stage object. -
OrchestrationStageName: string
Title:
Stage Name
Read Only:true
Maximum Length:100
The name of the orchestration stage. -
OrchestrationStageNumber: string
Title:
Orchestration Stage Number
Read Only:true
Maximum Length:64
The public unique identifier of the orchestration stage object. -
OrchestrationStepId: integer
(int64)
Title:
Orchestration Step ID
The unique identifier of the orchestration steps object. -
OrchestrationStepName: string
Title:
Orchestration Step Name
Maximum Length:100
The name of orchestration step. -
OrchestrationStepNumber: string
Title:
Orchestration Step Number
Maximum Length:64
The public unique identifier of the orchestration steps object. -
PreStepCondition: string
(byte)
Title:
Prestep Condition
The condition that gets executed prior to executing the orchestration step. -
SMARTActionId: integer
(int64)
Title:
Smart Action ID
The unique identifier of the smart action. -
StepSuggestionText: string
Title:
Step Suggestion Text
Maximum Length:2000
The suggestion text of the orchestration step. -
StepType: string
Title:
Step Type
Maximum Length:30
Step Type -
SuccessCriteria: string
(byte)
Title:
Success Criteria
The criteria used to identify whether a step is successful. -
SuccessStepId: integer
(int64)
Title:
Success Step ID
The unique identifier of the next step if current step succeeds. -
SuccessStepName: string
Title:
Orchestration Step Name
Read Only:true
Maximum Length:100
The name of orchestration step. -
SuccessStepNumber: string
Title:
Orchestration Step Number
Maximum Length:64
The public unique identifier of the orchestration steps object. -
WaitForRepliesFlag: boolean
Title:
Wait for Replies Flag
Maximum Length:1
Default Value:false
Indicates whether the step has to wait for replies.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : orchestrations-Stages-StepTasks-item-response
Type:
Show Source
object
-
ActivityId: integer
(int64)
Title:
Activity ID
The unique identifier of the activity ID. -
ActivityTemplateId: integer
(int64)
Title:
Activity Template ID
The identifier for the Task and Appointment templates. -
AllowSkipFlag: boolean
Title:
Allow Step Skipping
Maximum Length:1
Default Value:true
Indicates whether or not to show skip or thumbs down icon in the guidance primary or secondary banner. -
AssignedTo: string
Title:
Assigned To
Maximum Length:30
Default Value:OWNER
Indicates to whom the activity should be assigned to when it's generated. Possible values are OWNER, TEAM MEMBER, and CUSTOM CONDITION. -
AssignedToRule: string
(byte)
Title:
Assigned to Rule
The rule when AssignedTo is specified as CUSTOM_CONDITION. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
DisplaySequence: integer
(int32)
Title:
Display Sequence
The order of the steps in the orchestration administrator runtime UIs. -
EmailTemplateId: integer
(int64)
Title:
Email Template ID
The unique identifier of the email template that will be defaulted at run time. -
EvaluateOnMarkCompleteFlag: boolean
Title:
Evaluate on Marked as Completed
Maximum Length:1
Default Value:false
Indicates whether or not to evaluate the success criteria when a task or an appointment is marked as complete. -
FieldUpdateJson: string
(byte)
Title:
Field Update JSON
The JSON structure containing the list of fields to update on source object. -
GracePeriod: integer
Title:
Grace Period
Specifies the number of hours to wait before treating the Step as failed. This is applicable only for manual steps. -
IATemplateValue: string
Title:
IA Template Value
Maximum Length:100
The name of the intelligent advisor guide template. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrchestrationStageId: integer
(int64)
Title:
Orchestration Stage ID
The unique identifier of the orchestrations stage object. -
OrchestrationStageName: string
Title:
Stage Name
Read Only:true
Maximum Length:100
The unique identifier of the orchestrations stage object. -
OrchestrationStageNumber: string
Title:
Orchestration Stage Number
Read Only:true
Maximum Length:64
The name of the orchestration stage. -
OrchestrationStepId: integer
(int64)
Title:
Orchestration Step ID
The unique identifier of the orchestration steps object. -
OrchestrationStepName: string
Title:
Orchestration Step Name
Read Only:true
Maximum Length:100
The name of orchestration step. -
OrchestrationStepNumber: string
Title:
Orchestration Step Number
Maximum Length:64
The public unique identifier of the orchestration steps object. -
OrchestrationStepTaskDescription: string
(byte)
Title:
Orchestration Step Task Description
Read Only:true
The description of the orchestration step task. -
OrchestrationStepTaskName: string
Title:
Orchestration Step Task Name
Read Only:true
Maximum Length:500
The name of the orchestration step task. -
SMARTActionId: integer
(int64)
Title:
Smart Action ID
The unique identifier of the smart action. -
StepTasksId: integer
(int64)
Title:
Orchestration Step Tasks ID
The unique identifier of the orchestration step tasks object. -
StepTasksNumber: string
Title:
Orchestration Step Tasks Number
Maximum Length:64
The public unique identifier of the orchestration step tasks object. -
WaitForRepliesFlag: boolean
Title:
Wait for Replies Flag
Maximum Length:1
Default Value:false
Indicates whether the step has to wait for replies.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ErrorLogs
-
Parameters:
- OrchestrationNumber:
$request.path.OrchestrationNumber
The error logs resource is used to view the error details. - OrchestrationNumber:
- OrchestrationSourceObjectsVA
-
Parameters:
- finder:
OrchSupportedObjectsFinder
The following properties are defined on the LOV link relation:- Source Attribute: ObjectCode; Target Attribute: ObjectCode
- Display Attribute: DisplayName
- finder:
- OrchestrationTypeVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_ORCH_DT_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: OrchestrationType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- PerformActionVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_ORCH_PERFORM_ACTION
The following properties are defined on the LOV link relation:- Source Attribute: PerformAction; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- Stages
-
Parameters:
- OrchestrationNumber:
$request.path.OrchestrationNumber
The stages resource is used to view, create, update, and delete an orchestration stage. The stages are a collection of steps, objectives, and associations. - OrchestrationNumber:
- StatusCodeVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_ORCH_DT_STATUS
The following properties are defined on the LOV link relation:- Source Attribute: StatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
Examples
The following example shows how to update an orchestration by submitting a PATCH request on the REST resource.
cURL Command
curl -u <username:password> \ -X PATCH https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/orchestrations/CDRM_1001 \ -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json' | json_pp
Example of Request Body
The following example shows the contents of the request body in JSON
format.
{ "OrchestrationName": "From Sales REST API" }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "OrchestrationId": 300100563170364, "OrchestrationNumber": "CDRM_1001", "OrchestrationName": "From Sales REST API", "OrchestrationDescription": "From REST_042", "ObjectCode": "Lead", "StripingAttributeName": null, "StripingAttributeValue": null, "LifecycleAttributeName": "StatusCode", "OrchestrationType": "GUIDEDSELLING", "SourceOrchestrationId": null, "StatusCode": "DRAFT", "ActivationDateTime": null, "AssociationRank": 1, "CreationDate": "2022-09-26T05:57:07+00:00", "CreatedBy": "SALES_ADMIN", "LastUpdatedBy": "SALES_ADMIN", "LastUpdateDate": "2022-09-27T07:19:24.082+00:00", "DeleteFlag": true, "UpdateFlag": true, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/orchestrations/CDRM_1001", "name": "orchestrations", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/orchestrations/CDRM_1001", "name": "orchestrations", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/orchestrations/CDRM_1001/child/ErrorLogs", "name": "ErrorLogs", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/orchestrations/CDRM_1001/child/Stages", "name": "Stages", "kind": "collection" }, { "rel": "enclosure", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/orchestrations/CDRM_1001/enclosure/AssociationCriteriaExpression", "name": "AssociationCriteriaExpression", "kind": "other" } ] }