Update an orchestration step
patch
/crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/Steps/{OrchestrationStepNumber}
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=
-
OrchestrationStageNumber(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=
-
OrchestrationStepNumber(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
-
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.
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-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 : 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.
Links
- ExecutionMethodVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_ORCH_STP_DT_EXECMETHD
The following properties are defined on the LOV link relation:- Source Attribute: ExecutionMethod; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- StepTypeVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_ORCH_STEP_DT_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: StepType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: