Get a step transition
get
/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/StepTransitions/{StepTransitionNumber}
Request
Path Parameters
-
OptyNumber(required): string
The unique alternate identifier for the opportunity.
-
OrchestrationAssociationNumber(required): string
The alternate identifier of the orchestration association.
-
StepTransitionNumber(required): string
The alternate identifier of the orchestration step transition object.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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 : opportunities-OrchestrationAssociations-StepTransitions-item-response
Type:
Show Source
object
-
ActivityAppointmentStatusCode: string
Title:
Appointment Status
Read Only:true
Maximum Length:30
Denotes the status of the Appointment. -
ActivityDescription: string
(byte)
Title:
Description
Read Only:true
A text field for capturing some descriptive information about the activity. -
ActivityDueDate: string
(date)
Title:
Due Date
Read Only:true
The date the task activity is due to be completed. -
ActivityEndDate: string
(date-time)
Title:
End Date
Read Only:true
The end date and time of an appointment, or the completion time of a task. -
ActivityId: integer
(int64)
Title:
Activity ID
The unique identifier of the activity. -
ActivityNumber: string
Title:
Activity Number
Read Only:true
Maximum Length:64
Alternate identifier of the activity. System generated or can come from external system (user key). -
ActivityOwnerId: integer
(int64)
Title:
Owner ID
Read Only:true
The primary resource on the activity. Supports resources only. -
ActivityOwnerPartyName: string
Title:
Owner
Read Only:true
Maximum Length:360
Name of the party. -
ActivityPartialDescription: string
Title:
Short Description
Read Only:true
Maximum Length:4000
A column that stores the first 4000 characters of activity description. -
ActivitySMARTActionContext: string
Title:
Smart Action Context
Read Only:true
Maximum Length:4000
Stores metadata needed for smart action -
ActivitySMARTActionId: integer
(int64)
Title:
Smart Action ID
Read Only:true
Smart action identifier. Foriegn key from zca_user_action. -
ActivityStartDate: string
(date-time)
Title:
Start Date
Read Only:true
The start date and time of an appointment or a task. Defaulted to null for an appointment and defaulted to creation datetime for a task. -
ActivitySubject: string
Title:
Subject
Read Only:true
Maximum Length:500
Subject or name ot title of the activity. -
ActivityTaskStatusCode: string
Title:
Status
Read Only:true
Maximum Length:30
Status of the activity. Defaulted to NOT_STARTED. -
ActivityWebConferenceId: string
Title:
Web Conference ID
Read Only:true
Maximum Length:255
The unique identifier of the web conference. -
ActivityWebConferenceURL: string
Title:
Web Conference URL
Read Only:true
Maximum Length:2000
The web conference join URL. -
AllowSkipFlag: boolean
Title:
Allow Step Skipping
Read Only:true
Maximum Length:1
Default Value:true
Indicates whether or not to show skip or thumbs down icon in guidance primary or secondary banner. -
Comments: string
Title:
Comments
Maximum Length:2000
Specifies the brief comments required for runtime step transition row. -
ConversationId: integer
(int64)
Title:
Conversation ID
The unique identifier of conversation message. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
EmailType: string
Title:
Email Type
Maximum Length:30
The orchestration step transition runtime email type. -
ExitOrchestrationFlag: boolean
Title:
Exit Orchestration
Read Only:true
Maximum Length:1
Indicates whether or not to exit the orchestration when stop step occurs. -
InboundConvMsgId: integer
(int64)
Title:
Inbound Conversation Message ID
The unique identifier of inbound conversation message. -
InteractionId: integer
(int64)
Title:
Interaction ID
The unique identifier of interaction. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date 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. -
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. -
OrchestrationAssociationNumber: string
Title:
Orchestration Association Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration association. -
OrchestrationId: integer
(int64)
Title:
Orchestration ID
The unique identifier of the orchestration object. -
OrchestrationName: string
Title:
Orchestration Name
Read Only:true
Maximum Length:100
The name of orchestration object. -
OrchestrationNumber: string
Title:
Orchestration Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration object. -
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 object. -
OrchestrationStageNumber: string
Title:
Orchestration Stage Number
Read Only:true
Maximum Length:64
The alternate identifier of the orchestration stage object. -
OrchestrationStepId: integer
(int64)
Title:
Orchestration Step ID
The unique identifier of the orchestration step 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 alternate identifier of the orchestration step object. -
OrchestrationStepTasksId: integer
(int64)
Title:
Orchestration Step Tasks ID
Unique identifier for the orchestration step tasks. -
OrchestrationStepType: string
Title:
Step Type
Read Only:true
Maximum Length:30
The type of step. -
OrchStepTransitionFlag: boolean
Title:
Current Step Transition
Maximum Length:1
Indicates whether it's the current INPROGRESS Step transition or the most recently updated step transition row. -
OutboundConvMsgId: integer
(int64)
Title:
Outbound Conversation Message ID
The unique identifier of outbound conversation message. -
RefreshPageFlag: boolean
Title:
Refresh Page
Maximum Length:1
Indicates whether or not to refresh the whole page before surfacing the current Step in the runtime UI. -
StepDisplaySequence: integer
Title:
Display Sequence
Read Only:true
The order of the steps in the orchestration administrator runtime UIs. -
StepSuggestionText: string
Title:
Step Suggestion Text
Read Only:true
Maximum Length:2000
Suggestion text of the Orchestration step. -
StepTaskDisplaySequence: integer
(int32)
Title:
Display Sequence
Read Only:true
The order of the steps in the orchestration administrator runtime UIs. -
StepTransitionId: integer
(int64)
Title:
Step Transition ID
The unique identifier of the orchestration step transition object. -
StepTransitionNumber: string
Title:
Step Transition Number
Maximum Length:64
The alternate identifier of the orchestration step transition object. -
StepType: string
Title:
Step Type
Maximum Length:30
The type of the step to which the step transitions correspond to. -
SuccessCriteriaEvalFlag: boolean
Title:
Success Criteria Evaluation Flag
Maximum Length:1
Specifies the success criteria evaluation result for the step. -
TransitionDueDateTime: string
(date-time)
Title:
Transition Due Date Time
The date and time when the step transition is due. -
TransitionEndDateTime: string
(date-time)
Title:
Transition End Date Time
The date and time when the step transition ended. -
TransitionStartDateTime: string
(date-time)
Title:
Transition Start Date Time
The date and time when the step transition started. -
TransitionStatus: string
Title:
Transition Status
Maximum Length:30
The status of the orchestration step transition. -
WrapUpId: integer
(int64)
Title:
Wrap-up ID
The unique identifier of the wrap up.
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
- EmailTypeVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_ORCH_EMAIL_TYPE
The list of values indicating the email type of the runtime orchestration step transition. - finder:
- TransitionStatusVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_ORCH_STPTRNS_RT_STATUS
The list of values indicating the runtime status of the runtime orchestration step transition. - finder: