Get a step task
get
/crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/StepTasks/{StepTasksNumber}
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=
-
StepTasksNumber(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=
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 : 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
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
- AssignedToVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_ORCH_DT_TASK_ASSIGNEE
The following properties are defined on the LOV link relation:- Source Attribute: AssignedTo; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: