Jump to

• Request
• Response

Create an orchestration stage

post

/crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ContainErrorsFlag: boolean
  Title: Contain Errors

  Maximum Length: 1

  Indicates whether the orchestration stage contains any validation errors.
• DisplaySequence(required): integer (int32)
  Title: Display Sequence

  The order of the orchestration stages in the orchestration administrator run time user interfaces.
• OrchestrationId(required): integer (int64)
  Title: Orchestration ID

  The 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(required): 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.

{
    "required":[
        "DisplaySequence",
        "OrchestrationId",
        "StageName"
    ],
    "type":"object",
    "properties":{
        "Steps":{
            "title":"Steps",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/orchestrations-Stages-Steps-item-post-request"
            }
        },
        "OrchestrationStageNumber":{
            "title":"Orchestration Stage Number",
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of the orchestration stage object.",
            "nullable":false
        },
        "StageDescription":{
            "title":"Objective Description",
            "maxLength":"2000",
            "type":"string",
            "description":"The description text of the orchestration stage object.",
            "nullable":true,
            "x-queryable":false
        },
        "StepObjectivesAssociations":{
            "title":"Step Objective Associations",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/orchestrations-Stages-StepObjectivesAssociations-item-post-request"
            }
        },
        "ContainErrorsFlag":{
            "title":"Contain Errors",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the orchestration stage contains any validation errors.",
            "nullable":true,
            "x-queryable":false
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order of the orchestration stages in the orchestration administrator run time user interfaces.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "StageName":{
            "title":"Stage Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the orchestration stage.",
            "nullable":false
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "StageObjectives":{
            "title":"Stage Objectives",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/orchestrations-Stages-StageObjectives-item-post-request"
            }
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "StepTasks":{
            "title":"Step Tasks",
            "type":"array",
            "description":"Step tasks contains the list of tasks and their related information for a given step.",
            "items":{
                "$ref":"#/components/schemas/orchestrations-Stages-StepTasks-item-post-request"
            }
        }
    }
}

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

• Array of: object orchestrations-Stages-StageObjectives-item-post-request

{
    "title":"Stage Objectives",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/orchestrations-Stages-StageObjectives-item-post-request"
    }
}

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

• Array of: object schema

{
    "title":"Step Objective Associations",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/orchestrations-Stages-StepObjectivesAssociations-item-post-request"
    }
}

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

• Array of: object schema

{
    "title":"Steps",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/orchestrations-Stages-Steps-item-post-request"
    }
}

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

• Array of: object orchestrations-Stages-StepTasks-item-post-request

{
    "title":"Step Tasks",
    "type":"array",
    "description":"Step tasks contains the list of tasks and their related information for a given step.",
    "items":{
        "$ref":"#/components/schemas/orchestrations-Stages-StepTasks-item-post-request"
    }
}

Nested Schema : orchestrations-Stages-StageObjectives-item-post-request

Type: object

Show Source

• 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.
• OrchestrationStageId: integer (int64)
  Title: Orchestration Stage ID

  The unique identifier of the orchestrations 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.

{
    "type":"object",
    "properties":{
        "StageObjectiveId":{
            "title":"Stage Objective ID",
            "type":"integer",
            "description":"The unique identifier of the Orchestration stage objective object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order of the objectives in the orchestration administrator runtime user interface.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestrations stage object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "StageObjectiveNumber":{
            "title":"Stage Objective Number",
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of the orchestration stage objective object.",
            "nullable":false
        },
        "ObjectiveStatus":{
            "title":"Objective Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the objective. Possible values are NEW or MAPPED.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ObjectiveName":{
            "title":"Objective Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the orchestration stage objective object.",
            "nullable":false
        },
        "ObjectiveDescription":{
            "title":"Objective Description",
            "maxLength":"2000",
            "type":"string",
            "description":"The description text of the orchestration stage objective object.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• OrchestrationStageId: integer (int64)
  Title: Orchestration Stage ID

  The 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.
• OrchestrationStepNumber: string
  Title: Orchestration Step Number

  Maximum Length: 64

  The public unique identifier of the orchestration steps 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.

{
    "type":"object",
    "properties":{
        "StepObjectiveAssocId":{
            "title":"Step Objective Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration step objectives association object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrchestrationStepId":{
            "title":"Orchestration Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration steps object.",
            "nullable":false
        },
        "StageObjectiveNumber":{
            "title":"Stage Objective Number",
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of the orchestration stage objective object.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OrchestrationStepNumber":{
            "title":"Orchestration Step Number",
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of the orchestration steps object.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StepObjectiveAssocNumber":{
            "title":"Step Objective Association Number",
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of the orchestration step objectives association object.",
            "nullable":false
        },
        "OrchestrationStageObjectiveId":{
            "title":"Stage Objective ID",
            "type":"integer",
            "description":"The unique identifier of the Orchestration stage objective object.",
            "nullable":false
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.
• OrchestrationStageId: integer (int64)
  Title: Orchestration Stage ID

  The unique identifier of the orchestrations 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.
• 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.

{
    "type":"object",
    "properties":{
        "DaysToWait":{
            "title":"Days to Wait",
            "type":"integer",
            "description":"Specifies the number of days to wait.",
            "format":"int32",
            "nullable":true,
            "default":"0",
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "SuccessStepId":{
            "title":"Success Step ID",
            "type":"integer",
            "description":"The unique identifier of the next step if current step succeeds.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order of the steps in the orchestration administrator runtime UIs.",
            "nullable":false,
            "x-queryable":false
        },
        "StepType":{
            "title":"Step Type",
            "maxLength":"30",
            "type":"string",
            "description":"Step Type",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OrchestrationStepNumber":{
            "title":"Orchestration Step Number",
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of the orchestration steps object.",
            "nullable":false
        },
        "EmailTemplateId":{
            "title":"Email Template ID",
            "type":"integer",
            "description":"The unique identifier of the email template that will be defaulted at run time.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "EmailContactsFilterCriteria":{
            "title":"Email Contacts Filter Criteria",
            "type":"string",
            "description":"The criteria expression to filter the email contacts.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SuccessStepNumber":{
            "title":"Orchestration Step Number",
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of the orchestration steps object.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PreStepCondition":{
            "title":"Prestep Condition",
            "type":"string",
            "description":"The condition that gets executed prior to executing the orchestration step.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "EmailContsObjectCd":{
            "title":"Email Contact Filter Object",
            "maxLength":"1000",
            "type":"string",
            "description":"Specifies the object,emailField and dneField names on which the email contacts criteria is built.",
            "nullable":true,
            "x-queryable":false
        },
        "FailureStepId":{
            "title":"Failure Step ID",
            "type":"integer",
            "description":"The unique identifier of the next step if the current step fails.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "FieldUpdateJson":{
            "title":"Field Update JSON",
            "type":"string",
            "description":"The JSON structure containing the list of fields to update on source object.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestrations stage object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ExitOrchestrationFlag":{
            "title":"Exit Orchestration",
            "maxLength":"1",
            "type":"boolean",
            "description":"Flag that indicates whether or not to exit the orchestration when a stop step occurs.",
            "nullable":true,
            "x-queryable":false
        },
        "EvaluateOnMarkCompleteFlag":{
            "title":"Evaluate on Marked as Completed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether or not to evaluate the success criteria when a task or an appointment is marked as complete.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "AllowSkipFlag":{
            "title":"Allow Step Skipping",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether or not to show skip or thumbs down icon in the guidance primary or secondary banner.",
            "nullable":true,
            "default":true,
            "x-queryable":false
        },
        "HoursToWait":{
            "title":"Hours to Wait",
            "type":"integer",
            "description":"The number of hours to wait.",
            "nullable":true,
            "default":"0",
            "x-queryable":false
        },
        "FailureStepNumber":{
            "title":"Orchestration Step Number",
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of the orchestration steps object.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "IATemplateValue":{
            "title":"IA Template Value",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the intelligent advisor guide template.",
            "nullable":true,
            "x-queryable":false
        },
        "SMARTActionId":{
            "title":"Smart Action ID",
            "type":"integer",
            "description":"The unique identifier of the smart action.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrchestrationStepId":{
            "title":"Orchestration Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration steps object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ActivityTemplateId":{
            "title":"Activity Template ID",
            "type":"integer",
            "description":"The identifier for the Task and Appointment templates.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "WaitForRepliesFlag":{
            "title":"Wait for Replies Flag",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the step has to wait for replies.",
            "nullable":true,
            "default":false
        },
        "SuccessCriteria":{
            "title":"Success Criteria",
            "type":"string",
            "description":"The criteria used to identify whether a step is successful.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationStepName":{
            "title":"Orchestration Step Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of orchestration step.",
            "nullable":false
        },
        "ExecutionMethod":{
            "title":"Execution Method",
            "maxLength":"30",
            "type":"string",
            "description":"The execution type for the orchestration step. The possible values are Manual and Automatic.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "NextStageValue":{
            "title":"Next Stage Value",
            "maxLength":"100",
            "type":"string",
            "description":"The value of the Stage to which you need to progress.",
            "nullable":true,
            "x-queryable":false
        },
        "StepSuggestionText":{
            "title":"Step Suggestion Text",
            "maxLength":"2000",
            "type":"string",
            "description":"The suggestion text of the orchestration step.",
            "nullable":true,
            "x-queryable":false
        },
        "GracePeriod":{
            "title":"Grace Period",
            "type":"integer",
            "description":"Specifies the number of hours to wait before treating the Step as failed. This is applicable only for manual steps.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : orchestrations-Stages-StepTasks-item-post-request

Type: object

Show Source

• 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.
• 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.
• OrchestrationStageId: integer (int64)
  Title: Orchestration Stage ID

  The unique identifier of the orchestrations stage object.
• OrchestrationStepId: integer (int64)
  Title: Orchestration Step ID

  The unique identifier of the orchestration steps object.
• OrchestrationStepNumber: string
  Title: Orchestration Step Number

  Maximum Length: 64

  The public unique identifier of the orchestration steps object.
• 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.

{
    "type":"object",
    "properties":{
        "IATemplateValue":{
            "title":"IA Template Value",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the intelligent advisor guide template.",
            "nullable":true,
            "x-queryable":false
        },
        "SMARTActionId":{
            "title":"Smart Action ID",
            "type":"integer",
            "description":"The unique identifier of the smart action.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order of the steps in the orchestration administrator runtime UIs.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "OrchestrationStepId":{
            "title":"Orchestration Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration steps object.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ActivityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"The unique identifier of the activity ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ActivityTemplateId":{
            "title":"Activity Template ID",
            "type":"integer",
            "description":"The identifier for the Task and Appointment templates.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "WaitForRepliesFlag":{
            "title":"Wait for Replies Flag",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the step has to wait for replies.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "OrchestrationStepNumber":{
            "title":"Orchestration Step Number",
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of the orchestration steps object.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EmailTemplateId":{
            "title":"Email Template ID",
            "type":"integer",
            "description":"The unique identifier of the email template that will be defaulted at run time.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AssignedTo":{
            "title":"Assigned To",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates to whom the activity should be assigned to when it's generated. Possible values are OWNER, TEAM MEMBER, and CUSTOM CONDITION.",
            "nullable":true,
            "default":"OWNER",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FieldUpdateJson":{
            "title":"Field Update JSON",
            "type":"string",
            "description":"The JSON structure containing the list of fields to update on source object.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "StepTasksId":{
            "title":"Orchestration Step Tasks ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration step tasks object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestrations stage object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "EvaluateOnMarkCompleteFlag":{
            "title":"Evaluate on Marked as Completed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether or not to evaluate the success criteria when a task or an appointment is marked as complete.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "StepTasksNumber":{
            "title":"Orchestration Step Tasks Number",
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of the orchestration step tasks object.",
            "nullable":false
        },
        "AllowSkipFlag":{
            "title":"Allow Step Skipping",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether or not to show skip or thumbs down icon in the guidance primary or secondary banner.",
            "nullable":true,
            "default":true,
            "x-queryable":false
        },
        "GracePeriod":{
            "title":"Grace Period",
            "type":"integer",
            "description":"Specifies the number of hours to wait before treating the Step as failed. This is applicable only for manual steps.",
            "nullable":true,
            "x-queryable":false
        },
        "AssignedToRule":{
            "title":"Assigned to Rule",
            "type":"string",
            "description":"The rule when AssignedTo is specified as CUSTOM_CONDITION.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : orchestrations-Stages-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Steps":{
            "title":"Steps",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/orchestrations-Stages-Steps-item-response"
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchestrationStageNumber":{
            "title":"Orchestration Stage Number",
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of the orchestration stage object.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order of the orchestration stages in the orchestration administrator run time user interfaces.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "StageName":{
            "title":"Stage Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the orchestration stage.",
            "nullable":false,
            "x-queryable":true
        },
        "OrchestrationName":{
            "title":"Orchestration Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the orchestration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrchestrationNumber":{
            "title":"Orchestration Number",
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of the orchestration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "StageDescription":{
            "title":"Objective Description",
            "maxLength":"2000",
            "type":"string",
            "description":"The description text of the orchestration stage object.",
            "nullable":true,
            "x-queryable":false
        },
        "StepObjectivesAssociations":{
            "title":"Step Objective Associations",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/orchestrations-Stages-StepObjectivesAssociations-item-response"
            }
        },
        "ContainErrorsFlag":{
            "title":"Contain Errors",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the orchestration stage contains any validation errors.",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StageObjectives":{
            "title":"Stage Objectives",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/orchestrations-Stages-StageObjectives-item-response"
            }
        },
        "StepTasks":{
            "title":"Step Tasks",
            "type":"array",
            "description":"Step tasks contains the list of tasks and their related information for a given step.",
            "items":{
                "$ref":"#/components/schemas/orchestrations-Stages-StepTasks-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object orchestrations-Stages-StageObjectives-item-response

{
    "title":"Stage Objectives",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/orchestrations-Stages-StageObjectives-item-response"
    }
}

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

• Array of: object orchestrations-Stages-StepObjectivesAssociations-item-response

{
    "title":"Step Objective Associations",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/orchestrations-Stages-StepObjectivesAssociations-item-response"
    }
}

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

• Array of: object orchestrations-Stages-Steps-item-response

{
    "title":"Steps",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/orchestrations-Stages-Steps-item-response"
    }
}

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

• Array of: object orchestrations-Stages-StepTasks-item-response

{
    "title":"Step Tasks",
    "type":"array",
    "description":"Step tasks contains the list of tasks and their related information for a given step.",
    "items":{
        "$ref":"#/components/schemas/orchestrations-Stages-StepTasks-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : orchestrations-Stages-StageObjectives-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchestrationStageNumber":{
            "title":"Orchestration Stage Number",
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of the orchestration stage object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order of the objectives in the orchestration administrator runtime user interface.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "OrchestrationStageName":{
            "title":"Stage Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the orchestration stage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StageObjectiveId":{
            "title":"Stage Objective ID",
            "type":"integer",
            "description":"The unique identifier of the Orchestration stage objective object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestrations stage object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StageObjectiveNumber":{
            "title":"Stage Objective Number",
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of the orchestration stage objective object.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjectiveStatus":{
            "title":"Objective Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the objective. Possible values are NEW or MAPPED.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectiveName":{
            "title":"Objective Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the orchestration stage objective object.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectiveDescription":{
            "title":"Objective Description",
            "maxLength":"2000",
            "type":"string",
            "description":"The description text of the orchestration stage objective object.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : orchestrations-Stages-StepObjectivesAssociations-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchestrationStageNumber":{
            "title":"Orchestration Stage Number",
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of the orchestration stage object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "StepObjectiveAssocId":{
            "title":"Step Objective Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration step objectives association object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrchestrationStepId":{
            "title":"Orchestration Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration steps object.",
            "nullable":false,
            "x-queryable":true
        },
        "OrchestrationStepNumber":{
            "title":"Orchestration Step Number",
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of the orchestration steps object.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrchestrationStageName":{
            "title":"Stage Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the orchestration stage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StepObjectiveAssocNumber":{
            "title":"Step Objective Association Number",
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of the orchestration step objectives association object.",
            "nullable":false,
            "x-queryable":true
        },
        "StageObjectiveName":{
            "title":"Objective Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the orchestration stage objective object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchestrationStepName":{
            "title":"Orchestration Step Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of orchestration step.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchestrationStageObjectiveId":{
            "title":"Stage Objective ID",
            "type":"integer",
            "description":"The unique identifier of the Orchestration stage objective object.",
            "nullable":false,
            "x-queryable":true
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StageObjectiveNumber":{
            "title":"Stage Objective Number",
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of the orchestration stage objective object.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : orchestrations-Stages-Steps-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "DaysToWait":{
            "title":"Days to Wait",
            "type":"integer",
            "description":"Specifies the number of days to wait.",
            "format":"int32",
            "nullable":true,
            "default":"0",
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SuccessStepId":{
            "title":"Success Step ID",
            "type":"integer",
            "description":"The unique identifier of the next step if current step succeeds.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order of the steps in the orchestration administrator runtime UIs.",
            "nullable":false,
            "x-queryable":false
        },
        "StepType":{
            "title":"Step Type",
            "maxLength":"30",
            "type":"string",
            "description":"Step Type",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OrchestrationStepNumber":{
            "title":"Orchestration Step Number",
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of the orchestration steps object.",
            "nullable":false,
            "x-queryable":true
        },
        "EmailTemplateId":{
            "title":"Email Template ID",
            "type":"integer",
            "description":"The unique identifier of the email template that will be defaulted at run time.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrchestrationStageName":{
            "title":"Stage Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the orchestration stage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailContactsFilterCriteria":{
            "title":"Email Contacts Filter Criteria",
            "type":"string",
            "description":"The criteria expression to filter the email contacts.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SuccessStepNumber":{
            "title":"Orchestration Step Number",
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of the orchestration steps object.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PreStepCondition":{
            "title":"Prestep Condition",
            "type":"string",
            "description":"The condition that gets executed prior to executing the orchestration step.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "EmailContsObjectCd":{
            "title":"Email Contact Filter Object",
            "maxLength":"1000",
            "type":"string",
            "description":"Specifies the object,emailField and dneField names on which the email contacts criteria is built.",
            "nullable":true,
            "x-queryable":false
        },
        "FailureStepId":{
            "title":"Failure Step ID",
            "type":"integer",
            "description":"The unique identifier of the next step if the current step fails.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "FieldUpdateJson":{
            "title":"Field Update JSON",
            "type":"string",
            "description":"The JSON structure containing the list of fields to update on source object.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestrations stage object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExitOrchestrationFlag":{
            "title":"Exit Orchestration",
            "maxLength":"1",
            "type":"boolean",
            "description":"Flag that indicates whether or not to exit the orchestration when a stop step occurs.",
            "nullable":true,
            "x-queryable":false
        },
        "EvaluateOnMarkCompleteFlag":{
            "title":"Evaluate on Marked as Completed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether or not to evaluate the success criteria when a task or an appointment is marked as complete.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AllowSkipFlag":{
            "title":"Allow Step Skipping",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether or not to show skip or thumbs down icon in the guidance primary or secondary banner.",
            "nullable":true,
            "default":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "HoursToWait":{
            "title":"Hours to Wait",
            "type":"integer",
            "description":"The number of hours to wait.",
            "nullable":true,
            "default":"0",
            "x-queryable":false
        },
        "FailureStepNumber":{
            "title":"Orchestration Step Number",
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of the orchestration steps object.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "IATemplateValue":{
            "title":"IA Template Value",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the intelligent advisor guide template.",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationStageNumber":{
            "title":"Orchestration Stage Number",
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of the orchestration stage object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SMARTActionId":{
            "title":"Smart Action ID",
            "type":"integer",
            "description":"The unique identifier of the smart action.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrchestrationStepId":{
            "title":"Orchestration Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration steps object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SuccessStepName":{
            "title":"Orchestration Step Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of orchestration step.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityTemplateId":{
            "title":"Activity Template ID",
            "type":"integer",
            "description":"The identifier for the Task and Appointment templates.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "WaitForRepliesFlag":{
            "title":"Wait for Replies Flag",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the step has to wait for replies.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "SuccessCriteria":{
            "title":"Success Criteria",
            "type":"string",
            "description":"The criteria used to identify whether a step is successful.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationStepName":{
            "title":"Orchestration Step Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of orchestration step.",
            "nullable":false,
            "x-queryable":true
        },
        "ExecutionMethod":{
            "title":"Execution Method",
            "maxLength":"30",
            "type":"string",
            "description":"The execution type for the orchestration step. The possible values are Manual and Automatic.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FailureStepName":{
            "title":"Orchestration Step Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of orchestration step.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NextStageValue":{
            "title":"Next Stage Value",
            "maxLength":"100",
            "type":"string",
            "description":"The value of the Stage to which you need to progress.",
            "nullable":true,
            "x-queryable":false
        },
        "StepSuggestionText":{
            "title":"Step Suggestion Text",
            "maxLength":"2000",
            "type":"string",
            "description":"The suggestion text of the orchestration step.",
            "nullable":true,
            "x-queryable":false
        },
        "GracePeriod":{
            "title":"Grace Period",
            "type":"integer",
            "description":"Specifies the number of hours to wait before treating the Step as failed. This is applicable only for manual steps.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : orchestrations-Stages-StepTasks-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order of the steps in the orchestration administrator runtime UIs.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "ActivityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"The unique identifier of the activity ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrchestrationStepNumber":{
            "title":"Orchestration Step Number",
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of the orchestration steps object.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EmailTemplateId":{
            "title":"Email Template ID",
            "type":"integer",
            "description":"The unique identifier of the email template that will be defaulted at run time.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrchestrationStageName":{
            "title":"Stage Name",
            "maxLength":"100",
            "type":"string",
            "description":"The unique identifier of the orchestrations stage object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FieldUpdateJson":{
            "title":"Field Update JSON",
            "type":"string",
            "description":"The JSON structure containing the list of fields to update on source object.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestrations stage object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EvaluateOnMarkCompleteFlag":{
            "title":"Evaluate on Marked as Completed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether or not to evaluate the success criteria when a task or an appointment is marked as complete.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrchestrationStepTaskName":{
            "title":"Orchestration Step Task Name",
            "maxLength":"500",
            "type":"string",
            "description":"The name of the orchestration step task.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"ActivityEO.Subject",
                "protectionState":"TOKENIZED"
            },
            "x-queryable":true
        },
        "StepTasksNumber":{
            "title":"Orchestration Step Tasks Number",
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of the orchestration step tasks object.",
            "nullable":false,
            "x-queryable":true
        },
        "AllowSkipFlag":{
            "title":"Allow Step Skipping",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether or not to show skip or thumbs down icon in the guidance primary or secondary banner.",
            "nullable":true,
            "default":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IATemplateValue":{
            "title":"IA Template Value",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the intelligent advisor guide template.",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationStageNumber":{
            "title":"Orchestration Stage Number",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the orchestration stage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SMARTActionId":{
            "title":"Smart Action ID",
            "type":"integer",
            "description":"The unique identifier of the smart action.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrchestrationStepId":{
            "title":"Orchestration Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration steps object.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ActivityTemplateId":{
            "title":"Activity Template ID",
            "type":"integer",
            "description":"The identifier for the Task and Appointment templates.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WaitForRepliesFlag":{
            "title":"Wait for Replies Flag",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the step has to wait for replies.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "OrchestrationStepName":{
            "title":"Orchestration Step Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of orchestration step.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedTo":{
            "title":"Assigned To",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates to whom the activity should be assigned to when it's generated. Possible values are OWNER, TEAM MEMBER, and CUSTOM CONDITION.",
            "nullable":true,
            "default":"OWNER",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OrchestrationStepTaskDescription":{
            "title":"Orchestration Step Task Description",
            "type":"string",
            "description":"The description of the orchestration step task.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"ActivityEO.ActivityDesc",
                "protectionState":"TOKENIZED"
            },
            "x-queryable":true
        },
        "StepTasksId":{
            "title":"Orchestration Step Tasks ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration step tasks object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "GracePeriod":{
            "title":"Grace Period",
            "type":"integer",
            "description":"Specifies the number of hours to wait before treating the Step as failed. This is applicable only for manual steps.",
            "nullable":true,
            "x-queryable":false
        },
        "AssignedToRule":{
            "title":"Assigned to Rule",
            "type":"string",
            "description":"The rule when AssignedTo is specified as CUSTOM_CONDITION.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

StageObjectives

Operation: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/StageObjectives

Parameters:

• OrchestrationNumber: $request.path.OrchestrationNumber
• OrchestrationStageNumber: $request.path.OrchestrationStageNumber

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

Operation: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/StepObjectivesAssociations

Parameters:

• OrchestrationNumber: $request.path.OrchestrationNumber
• OrchestrationStageNumber: $request.path.OrchestrationStageNumber

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.

StepTasks

Operation: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/StepTasks

Parameters:

• OrchestrationNumber: $request.path.OrchestrationNumber
• OrchestrationStageNumber: $request.path.OrchestrationStageNumber

Step tasks contains the list of tasks and their related information for a given step.

Steps

Operation: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages/{OrchestrationStageNumber}/child/Steps

Parameters:

• OrchestrationNumber: $request.path.OrchestrationNumber
• OrchestrationStageNumber: $request.path.OrchestrationStageNumber

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.

Back to Top