Jump to

• Request
• Response

Update

patch

/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/OrchestrationAssociations/{accounts_OrchestrationAssociations_Id}

Request

Path Parameters

• PartyNumber(required): string
  The unique alternate identifier for the account party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number. Inactive records can't be updated.
• accounts_OrchestrationAssociations_Id(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: string
  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: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActionParameters: string
  Title: Action Parameters

  Maximum Length: 1000

  List of parameters required to execute the action specified through PERFORM_ACTION field.
• AssociationStatusCode: string
  Title: Association Status Code

  Maximum Length: 30

  The status of the association. The possible values include ACTIVE, EXITED, and COMPLETED.
• ErrorLogs: array Error Logs
  Title: Error Logs

  The error logs resource is used to view the error details.
• PerformAction: string
  Title: Action to Perform

  Maximum Length: 30

  The action that users can perform on this orchestration step.
• StageObjectives: array Stage Objectives
  Title: Stage Objectives

  The stage objectives resource is used to view the stage objectives of the orchestration association.
• Stages: array Stages
  Title: Stages

  The stages resource is used to view the stage of the orchestration association.
• Steps: array Steps
  Title: Steps

  The steps resource is used to view the steps of the orchestration association.
• StepsInExecutionPath: array Steps in the Execution Path
  Title: Steps in the Execution Path

  The Steps in the Execution Path resource is used to view all the steps including future steps in the execution path of the orchestration association.
• StepTransitions: array Step Transitions
  Title: Step Transitions

  The step transitions resource is used to view the step transitions of the orchestration association.

{
    "type":"object",
    "properties":{
        "ActionParameters":{
            "title":"Action Parameters",
            "maxLength":1000,
            "type":"string",
            "description":"List of parameters required to execute the action specified through PERFORM_ACTION field.",
            "nullable":true,
            "x-queryable":false
        },
        "AssociationStatusCode":{
            "title":"Association Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The status of the association. The possible values include ACTIVE, EXITED, and COMPLETED.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ErrorLogs":{
            "title":"Error Logs",
            "type":"array",
            "description":"The error logs resource is used to view the error details.",
            "items":{
                "$ref":"#/components/schemas/accounts-OrchestrationAssociations-ErrorLogs-item-patch-request"
            }
        },
        "PerformAction":{
            "title":"Action to Perform",
            "maxLength":30,
            "type":"string",
            "description":"The action that users can perform on this orchestration step.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StageObjectives":{
            "title":"Stage Objectives",
            "type":"array",
            "description":"The stage objectives resource is used to view the stage objectives of the orchestration association.",
            "items":{
                "$ref":"#/components/schemas/accounts-OrchestrationAssociations-StageObjectives-item-patch-request"
            }
        },
        "Stages":{
            "title":"Stages",
            "type":"array",
            "description":"The stages resource is used to view the stage of the orchestration association.",
            "items":{
                "$ref":"#/components/schemas/accounts-OrchestrationAssociations-Stages-item-patch-request"
            }
        },
        "StepTransitions":{
            "title":"Step Transitions",
            "type":"array",
            "description":"The step transitions resource is used to view the step transitions of the orchestration association.",
            "items":{
                "$ref":"#/components/schemas/accounts-OrchestrationAssociations-StepTransitions-item-patch-request"
            }
        },
        "Steps":{
            "title":"Steps",
            "type":"array",
            "description":"The steps resource is used to view the steps of the orchestration association.",
            "items":{
                "$ref":"#/components/schemas/accounts-OrchestrationAssociations-Steps-item-patch-request"
            }
        },
        "StepsInExecutionPath":{
            "title":"Steps in the Execution Path",
            "type":"array",
            "description":"The Steps in the Execution Path resource is used to view all the steps including future steps in the execution path of the orchestration association.",
            "items":{
                "$ref":"#/components/schemas/accounts-OrchestrationAssociations-StepsInExecutionPath-item-patch-request"
            }
        }
    }
}

Nested Schema : Error Logs

Type: array

Title: Error Logs

The error logs resource is used to view the error details.

Show Source

• Array of: object accounts-OrchestrationAssociations-ErrorLogs-item-patch-request

{
    "title":"Error Logs",
    "type":"array",
    "description":"The error logs resource is used to view the error details.",
    "items":{
        "$ref":"#/components/schemas/accounts-OrchestrationAssociations-ErrorLogs-item-patch-request"
    }
}

Nested Schema : Stage Objectives

Type: array

Title: Stage Objectives

The stage objectives resource is used to view the stage objectives of the orchestration association.

Show Source

• Array of: object accounts-OrchestrationAssociations-StageObjectives-item-patch-request

{
    "title":"Stage Objectives",
    "type":"array",
    "description":"The stage objectives resource is used to view the stage objectives of the orchestration association.",
    "items":{
        "$ref":"#/components/schemas/accounts-OrchestrationAssociations-StageObjectives-item-patch-request"
    }
}

Nested Schema : Stages

Type: array

Title: Stages

The stages resource is used to view the stage of the orchestration association.

Show Source

• Array of: object accounts-OrchestrationAssociations-Stages-item-patch-request

{
    "title":"Stages",
    "type":"array",
    "description":"The stages resource is used to view the stage of the orchestration association.",
    "items":{
        "$ref":"#/components/schemas/accounts-OrchestrationAssociations-Stages-item-patch-request"
    }
}

Nested Schema : Steps

Type: array

Title: Steps

The steps resource is used to view the steps of the orchestration association.

Show Source

• Array of: object accounts-OrchestrationAssociations-Steps-item-patch-request

{
    "title":"Steps",
    "type":"array",
    "description":"The steps resource is used to view the steps of the orchestration association.",
    "items":{
        "$ref":"#/components/schemas/accounts-OrchestrationAssociations-Steps-item-patch-request"
    }
}

Nested Schema : Steps in the Execution Path

Type: array

Title: Steps in the Execution Path

The Steps in the Execution Path resource is used to view all the steps including future steps in the execution path of the orchestration association.

Show Source

• Array of: object accounts-OrchestrationAssociations-StepsInExecutionPath-item-patch-request

{
    "title":"Steps in the Execution Path",
    "type":"array",
    "description":"The Steps in the Execution Path resource is used to view all the steps including future steps in the execution path of the orchestration association.",
    "items":{
        "$ref":"#/components/schemas/accounts-OrchestrationAssociations-StepsInExecutionPath-item-patch-request"
    }
}

Nested Schema : Step Transitions

Type: array

Title: Step Transitions

The step transitions resource is used to view the step transitions of the orchestration association.

Show Source

• Array of: object accounts-OrchestrationAssociations-StepTransitions-item-patch-request

{
    "title":"Step Transitions",
    "type":"array",
    "description":"The step transitions resource is used to view the step transitions of the orchestration association.",
    "items":{
        "$ref":"#/components/schemas/accounts-OrchestrationAssociations-StepTransitions-item-patch-request"
    }
}

Nested Schema : accounts-OrchestrationAssociations-ErrorLogs-item-patch-request

Type: object

Show Source

• ErrorDescription: string (byte)
  Title: Error Description

  The description of the error.
• ErrorText: string
  Title: Error Text

  Maximum Length: 2000

  Specifies the error call stack.
• OrchestrationAssociationId: integer (int64)
  Title: Orchestration Association ID

  The unique identifier of the orchestration association.
• OrchestrationStepId: integer (int64)
  Title: Orchestration Step ID

  The unique identifier of the orchestration steps object.
• SourceObjectCode: string
  Title: Source Object Code

  Maximum Length: 100

  The language independent code of the transactional object. For example, Lead or Opportunity.
• SourceObjectId: integer (int64)
  Title: Source Object ID

  The unique identifier of the source object.

{
    "type":"object",
    "properties":{
        "ErrorDescription":{
            "title":"Error Description",
            "type":"string",
            "description":"The description of the error.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ErrorText":{
            "title":"Error Text",
            "maxLength":2000,
            "type":"string",
            "description":"Specifies the error call stack.",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "OrchestrationStepId":{
            "title":"Orchestration Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration steps object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SourceObjectCode":{
            "title":"Source Object Code",
            "maxLength":100,
            "type":"string",
            "description":"The language independent code of the transactional object. For example, Lead or Opportunity.",
            "nullable":true
        },
        "SourceObjectId":{
            "title":"Source Object ID",
            "type":"integer",
            "description":"The unique identifier of the source object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : accounts-OrchestrationAssociations-StageObjectives-item-patch-request

Type: object

Show Source

• DisplaySequence: integer
  Title: Display Sequence

  The order in which the stage objectives are to be executed and shown in UI.
• RunTimeStatus: string
  Title: Run Time Status

  Maximum Length: 30

  The run time status of the orchestration stage objective transition.

{
    "type":"object",
    "properties":{
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order in which the stage objectives are to be executed and shown in UI.",
            "nullable":true
        },
        "RunTimeStatus":{
            "title":"Run Time Status",
            "maxLength":30,
            "type":"string",
            "description":"The run time status of the orchestration stage objective transition.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : accounts-OrchestrationAssociations-Stages-item-patch-request

Type: object

Show Source

• CompletedObjsCnt: integer
  Title: Completed Objectives Count

  Number of completed objectives.
• CurrentStageFlag: boolean
  Title: Current Stage

  Maximum Length: 1

  Indicates whether it's the current INPROGRESS stage or the most recently updated stage.
• DisplaySequence: integer
  Title: Display Sequence

  The order in which the stages are to be executed and shown in the UI.
• OrchestrationAssociationId: integer (int64)
  Title: Orchestration Association ID

  The unique identifier of the orchestration association on stages .
• PendingObjectivesCount: integer
  Title: Pending Objectives Count

  Number of pending objectives.
• RunTimeStatus: string
  Title: Run Time Status

  Maximum Length: 30

  The runtime status of the orchestration stages.
• SkippedNothelpfulObjsCnt: integer
  Title: Skipped Objectives Count

  Number of skipped or not helpful objectives.
• StageEndDate: string (date-time)
  Title: Stage End Date

  Specifies the date and time when the stage execution ends.
• StageStartDate: string (date-time)
  Title: Stage Start Date

  Specifies the date and time when the stage execution starts.
• TotalObjsCnt: integer
  Title: Total Objectives Count

  Total number of objectives.

{
    "type":"object",
    "properties":{
        "CompletedObjsCnt":{
            "title":"Completed Objectives Count",
            "type":"integer",
            "description":"Number of completed objectives.",
            "nullable":true,
            "x-queryable":false
        },
        "CurrentStageFlag":{
            "title":"Current Stage",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether it's the current INPROGRESS stage or the most recently updated stage.",
            "nullable":true,
            "x-queryable":false
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order in which the stages are to be executed and shown in the UI.",
            "nullable":true
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration association on stages .",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PendingObjectivesCount":{
            "title":"Pending Objectives Count",
            "type":"integer",
            "description":"Number of pending objectives.",
            "nullable":true,
            "x-queryable":false
        },
        "RunTimeStatus":{
            "title":"Run Time Status",
            "maxLength":30,
            "type":"string",
            "description":"The runtime status of the orchestration stages.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SkippedNothelpfulObjsCnt":{
            "title":"Skipped Objectives Count",
            "type":"integer",
            "description":"Number of skipped or not helpful objectives.",
            "nullable":true,
            "x-queryable":false
        },
        "StageEndDate":{
            "title":"Stage End Date",
            "type":"string",
            "description":"Specifies the date and time when the stage execution ends.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "StageStartDate":{
            "title":"Stage Start Date",
            "type":"string",
            "description":"Specifies the date and time when the stage execution starts.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "TotalObjsCnt":{
            "title":"Total Objectives Count",
            "type":"integer",
            "description":"Total number of objectives.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : accounts-OrchestrationAssociations-Steps-item-patch-request

Type: object

Show Source

• CurrentStepFlag: boolean
  Title: Current Step

  Maximum Length: 1

  Indicates whether it's the current INPROGRESS step or the most recently updated step.
• DisplaySequence: integer
  Title: Display Sequence

  The order in which the stage objectives to be executed or shown back in UI. The display sequence of the steps.
• OrchestrationAssociationId: integer (int64)
  Title: Orchestration Association ID

  The unique identifier of the orchestration association on steps.
• RunTimeStatus: string
  Title: Run Time Status

  Maximum Length: 30

  The runtime status of the orchestration steps.
• StepEndDate: string (date-time)
  Title: Step End Date

  Specifies the date and time when the step execution ends.
• StepStartDate: string (date-time)
  Title: Step Start Date

  Specifies the date and time when the step execution starts.

{
    "type":"object",
    "properties":{
        "CurrentStepFlag":{
            "title":"Current Step",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether it's the current INPROGRESS step or the most recently updated step.",
            "nullable":true,
            "x-queryable":false
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order in which the stage objectives to be executed or shown back in UI. The display sequence of the steps.",
            "nullable":true
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration association on steps.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RunTimeStatus":{
            "title":"Run Time Status",
            "maxLength":30,
            "type":"string",
            "description":"The runtime status of the orchestration steps.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StepEndDate":{
            "title":"Step End Date",
            "type":"string",
            "description":"Specifies the date and time when the step execution ends.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "StepStartDate":{
            "title":"Step Start Date",
            "type":"string",
            "description":"Specifies the date and time when the step execution starts.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : accounts-OrchestrationAssociations-StepsInExecutionPath-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : accounts-OrchestrationAssociations-StepTransitions-item-patch-request

Type: object

Show Source

• ActivityId: integer (int64)
  Title: Activity ID

  The unique identifier of the activity ID.
• Comments: string
  Title: Comments

  Maximum Length: 2000

  Specifies the brief comments required for runtime step transition row.
• ConversationId: integer (int64)
  Title: Conversation ID

  The unique identifier of conversation message.
• EmailType: string
  Title: Email Type

  Maximum Length: 30

  The type of the email to which the step transitions associated with.
• InboundConvMsgId: integer (int64)
  Title: Inbound Conversation Message ID

  The unique identifier of inbound conversation message.
• InteractionId: integer (int64)
  Title: Interaction ID

  The unique identifier of interaction.
• OrchestrationAssociationId: integer (int64)
  Title: Orchestration Association ID

  The unique identifier of the orchestration association on step transitions.
• OrchStepTransitionFlag: boolean
  Title: Current Step Transition

  Maximum Length: 1

  Indicates whether it's the current INPROGRESS step transition or the most recently updated step transition row.
• OutboundConvMsgId: integer (int64)
  Title: Outbound Conversation Message ID

  The unique identifier of outbound conversation message.
• RefreshPageFlag: boolean
  Title: Refresh Page

  Maximum Length: 1

  Specifies whether or not to refresh the whole page before surfacing the current step in the runtime UI.
• StepType: string
  Title: Step Type

  Maximum Length: 30

  The type of the step to which the step transitions correspond to.
• SuccessCriteriaEvalFlag: boolean
  Title: Success Criteria Evaluation Flag

  Maximum Length: 1

  Specifies the success criteria evaluation result for the step.
• TransitionDueDateTime: string (date-time)
  Title: Transition Due Date Time

  The date and timestamp when the step transition is due.
• TransitionEndDateTime: string (date-time)
  Title: Transition End Date Time

  The date and timestamp when the step transition ended.
• TransitionStartDateTime: string (date-time)
  Title: Transition Start Date Time

  The date and timestamp when the step transition started.
• TransitionStatus: string
  Title: Transition Status

  Maximum Length: 30

  The status of the orchestration step transition.
• WrapUpId: integer (int64)
  Title: Wrap-up ID

  The unique identifier of the wrap up.

{
    "type":"object",
    "properties":{
        "ActivityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"The unique identifier of the activity ID.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":2000,
            "type":"string",
            "description":"Specifies the brief comments required for runtime step transition row.",
            "nullable":true,
            "x-queryable":false
        },
        "ConversationId":{
            "title":"Conversation ID",
            "type":"integer",
            "description":"The unique identifier of conversation message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EmailType":{
            "title":"Email Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the email to which the step transitions associated with.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InboundConvMsgId":{
            "title":"Inbound Conversation Message ID",
            "type":"integer",
            "description":"The unique identifier of inbound conversation message.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "InteractionId":{
            "title":"Interaction ID",
            "type":"integer",
            "description":"The unique identifier of interaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "OrchStepTransitionFlag":{
            "title":"Current Step Transition",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether it's the current INPROGRESS step transition or the most recently updated step transition row.",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration association on step transitions.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OutboundConvMsgId":{
            "title":"Outbound Conversation Message ID",
            "type":"integer",
            "description":"The unique identifier of outbound conversation message.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RefreshPageFlag":{
            "title":"Refresh Page",
            "maxLength":1,
            "type":"boolean",
            "description":"Specifies whether or not to refresh the whole page before surfacing the current step in the runtime UI.",
            "nullable":true,
            "x-queryable":false
        },
        "StepType":{
            "title":"Step Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the step to which the step transitions correspond to.",
            "nullable":false
        },
        "SuccessCriteriaEvalFlag":{
            "title":"Success Criteria Evaluation Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Specifies the success criteria evaluation result for the step.",
            "nullable":true,
            "x-queryable":false
        },
        "TransitionDueDateTime":{
            "title":"Transition Due Date Time",
            "type":"string",
            "description":"The date and timestamp when the step transition is due.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "TransitionEndDateTime":{
            "title":"Transition End Date Time",
            "type":"string",
            "description":"The date and timestamp when the step transition ended.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "TransitionStartDateTime":{
            "title":"Transition Start Date Time",
            "type":"string",
            "description":"The date and timestamp when the step transition started.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "TransitionStatus":{
            "title":"Transition Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the orchestration step transition.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "WrapUpId":{
            "title":"Wrap-up ID",
            "type":"integer",
            "description":"The unique identifier of the wrap up.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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 : accounts-OrchestrationAssociations-item-response

Type: object

Show Source

• ActionParameters: string
  Title: Action Parameters

  Maximum Length: 1000

  List of parameters required to execute the action specified through PERFORM_ACTION field.
• AssociationStatusCode: string
  Title: Association Status Code

  Maximum Length: 30

  The status of the association. The possible values include ACTIVE, EXITED, and COMPLETED.
• CompletedObjsCnt: integer
  Title: Completed Objectives Count

  Read Only: true

  Number of completed objectives.
• 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.
• CurrentAssocFlag: boolean
  Title: Current Association

  Read Only: true

  Maximum Length: 1

  Indicates whether it's the current ACTIVE association or the most recently updated association.
• ErrorLogs: array Error Logs
  Title: Error Logs

  The error logs resource is used to view the error details.
• 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.
• NextStepId: integer (int64)
  Title: Next Step ID

  Read Only: true

  The unique identifier for the next step to run in the current orchestration.
• NextStepSmartActionId: integer (int64)
  Title: Next Step Smart Action ID

  Read Only: true

  The unique identifier for the smart action in the next step that will run in the current orchestration.
• OrchestrationAssociationId: integer (int64)
  Title: Orchestration Association ID

  The unique identifier of the orchestration association.
• OrchestrationAssociationNumber: string
  Title: Orchestration Association Number

  Maximum Length: 64

  The alternate unique identifier of the orchestration association.
• OrchestrationId: integer (int64)
  Title: Orchestration ID

  The unique identifier of the orchestrations object.
• 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.
• PendingObjectivesCount: integer
  Title: Pending Objectives Count

  Read Only: true

  Number of pending objectives for stage.
• PerformAction: string
  Title: Action to Perform

  Maximum Length: 30

  The action that users can perform on this orchestration step.
• SkippedNothelpfulObjsCnt: integer
  Title: Skipped Objectives Count

  Read Only: true

  Number of skipped or not helpful objectives.
• SourceObjectCode: string
  Title: Source Object Code

  Maximum Length: 100

  The language-independent object code such as Lead or Opportunity.
• SourceObjectId: integer (int64)
  Title: Source Object ID

  The unique identifier for the source object code such as LeadId or OpportunityId.
• StageObjectives: array Stage Objectives
  Title: Stage Objectives

  The stage objectives resource is used to view the stage objectives of the orchestration association.
• Stages: array Stages
  Title: Stages

  The stages resource is used to view the stage of the orchestration association.
• Steps: array Steps
  Title: Steps

  The steps resource is used to view the steps of the orchestration association.
• StepsInExecutionPath: array Steps in the Execution Path
  Title: Steps in the Execution Path

  The Steps in the Execution Path resource is used to view all the steps including future steps in the execution path of the orchestration association.
• StepTransitions: array Step Transitions
  Title: Step Transitions

  The step transitions resource is used to view the step transitions of the orchestration association.
• TotalObjsCnt: integer
  Title: Total Objectives Count

  Read Only: true

  Total number of objectives.

{
    "type":"object",
    "properties":{
        "ActionParameters":{
            "title":"Action Parameters",
            "maxLength":1000,
            "type":"string",
            "description":"List of parameters required to execute the action specified through PERFORM_ACTION field.",
            "nullable":true,
            "x-queryable":false
        },
        "AssociationStatusCode":{
            "title":"Association Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The status of the association. The possible values include ACTIVE, EXITED, and COMPLETED.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CompletedObjsCnt":{
            "title":"Completed Objectives Count",
            "type":"integer",
            "description":"Number of completed objectives.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created 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
        },
        "CurrentAssocFlag":{
            "title":"Current Association",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether it's the current ACTIVE association or the most recently updated association.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ErrorLogs":{
            "title":"Error Logs",
            "type":"array",
            "description":"The error logs resource is used to view the error details.",
            "items":{
                "$ref":"#/components/schemas/accounts-OrchestrationAssociations-ErrorLogs-item-response"
            }
        },
        "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
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NextStepId":{
            "title":"Next Step ID",
            "type":"integer",
            "description":"The unique identifier for the next step to run in the current orchestration.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "NextStepSmartActionId":{
            "title":"Next Step Smart Action ID",
            "type":"integer",
            "description":"The unique identifier for the smart action in the next step that will run in the current orchestration.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationAssociationNumber":{
            "title":"Orchestration Association Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate unique identifier of the orchestration association.",
            "nullable":false,
            "x-queryable":true
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestrations object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationName":{
            "title":"Orchestration Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the orchestration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationNumber":{
            "title":"Orchestration Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of the orchestration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PendingObjectivesCount":{
            "title":"Pending Objectives Count",
            "type":"integer",
            "description":"Number of pending objectives for stage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PerformAction":{
            "title":"Action to Perform",
            "maxLength":30,
            "type":"string",
            "description":"The action that users can perform on this orchestration step.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SkippedNothelpfulObjsCnt":{
            "title":"Skipped Objectives Count",
            "type":"integer",
            "description":"Number of skipped or not helpful objectives.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceObjectCode":{
            "title":"Source Object Code",
            "maxLength":100,
            "type":"string",
            "description":"The language-independent object code such as Lead or Opportunity.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectId":{
            "title":"Source Object ID",
            "type":"integer",
            "description":"The unique identifier for the source object code such as LeadId or OpportunityId.",
            "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 the stage objectives of the orchestration association.",
            "items":{
                "$ref":"#/components/schemas/accounts-OrchestrationAssociations-StageObjectives-item-response"
            }
        },
        "Stages":{
            "title":"Stages",
            "type":"array",
            "description":"The stages resource is used to view the stage of the orchestration association.",
            "items":{
                "$ref":"#/components/schemas/accounts-OrchestrationAssociations-Stages-item-response"
            }
        },
        "StepTransitions":{
            "title":"Step Transitions",
            "type":"array",
            "description":"The step transitions resource is used to view the step transitions of the orchestration association.",
            "items":{
                "$ref":"#/components/schemas/accounts-OrchestrationAssociations-StepTransitions-item-response"
            }
        },
        "Steps":{
            "title":"Steps",
            "type":"array",
            "description":"The steps resource is used to view the steps of the orchestration association.",
            "items":{
                "$ref":"#/components/schemas/accounts-OrchestrationAssociations-Steps-item-response"
            }
        },
        "StepsInExecutionPath":{
            "title":"Steps in the Execution Path",
            "type":"array",
            "description":"The Steps in the Execution Path resource is used to view all the steps including future steps in the execution path of the orchestration association.",
            "items":{
                "$ref":"#/components/schemas/accounts-OrchestrationAssociations-StepsInExecutionPath-item-response"
            }
        },
        "TotalObjsCnt":{
            "title":"Total Objectives Count",
            "type":"integer",
            "description":"Total number of objectives.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Error Logs

Type: array

Title: Error Logs

The error logs resource is used to view the error details.

Show Source

• Array of: object accounts-OrchestrationAssociations-ErrorLogs-item-response

{
    "title":"Error Logs",
    "type":"array",
    "description":"The error logs resource is used to view the error details.",
    "items":{
        "$ref":"#/components/schemas/accounts-OrchestrationAssociations-ErrorLogs-item-response"
    }
}

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 the stage objectives of the orchestration association.

Show Source

• Array of: object accounts-OrchestrationAssociations-StageObjectives-item-response

{
    "title":"Stage Objectives",
    "type":"array",
    "description":"The stage objectives resource is used to view the stage objectives of the orchestration association.",
    "items":{
        "$ref":"#/components/schemas/accounts-OrchestrationAssociations-StageObjectives-item-response"
    }
}

Nested Schema : Stages

Type: array

Title: Stages

The stages resource is used to view the stage of the orchestration association.

Show Source

• Array of: object accounts-OrchestrationAssociations-Stages-item-response

{
    "title":"Stages",
    "type":"array",
    "description":"The stages resource is used to view the stage of the orchestration association.",
    "items":{
        "$ref":"#/components/schemas/accounts-OrchestrationAssociations-Stages-item-response"
    }
}

Nested Schema : Steps

Type: array

Title: Steps

The steps resource is used to view the steps of the orchestration association.

Show Source

• Array of: object accounts-OrchestrationAssociations-Steps-item-response

{
    "title":"Steps",
    "type":"array",
    "description":"The steps resource is used to view the steps of the orchestration association.",
    "items":{
        "$ref":"#/components/schemas/accounts-OrchestrationAssociations-Steps-item-response"
    }
}

Nested Schema : Steps in the Execution Path

Type: array

Title: Steps in the Execution Path

The Steps in the Execution Path resource is used to view all the steps including future steps in the execution path of the orchestration association.

Show Source

• Array of: object accounts-OrchestrationAssociations-StepsInExecutionPath-item-response

{
    "title":"Steps in the Execution Path",
    "type":"array",
    "description":"The Steps in the Execution Path resource is used to view all the steps including future steps in the execution path of the orchestration association.",
    "items":{
        "$ref":"#/components/schemas/accounts-OrchestrationAssociations-StepsInExecutionPath-item-response"
    }
}

Nested Schema : Step Transitions

Type: array

Title: Step Transitions

The step transitions resource is used to view the step transitions of the orchestration association.

Show Source

• Array of: object accounts-OrchestrationAssociations-StepTransitions-item-response

{
    "title":"Step Transitions",
    "type":"array",
    "description":"The step transitions resource is used to view the step transitions of the orchestration association.",
    "items":{
        "$ref":"#/components/schemas/accounts-OrchestrationAssociations-StepTransitions-item-response"
    }
}

Nested Schema : accounts-OrchestrationAssociations-ErrorLogs-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.
• ErrorDescription: string (byte)
  Title: Error Description

  The description of the error.
• ErrorLogsId: integer (int64)
  Title: Error Logs ID

  The unique identifier of the orchestration error logs.
• ErrorLogsNumber: string
  Title: Error Logs Number

  Maximum Length: 64

  The public unique identifier or alternate key of the orchestration error log.
• ErrorText: string
  Title: Error Text

  Maximum Length: 2000

  Specifies the error call stack.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrchestrationAssociationId: integer (int64)
  Title: Orchestration Association ID

  The unique identifier of the orchestration association.
• OrchestrationId: integer (int64)
  Title: Orchestration ID

  The unique identifier of the orchestration.
• OrchestrationName: string
  Title: Orchestration Name

  Read Only: true

  Maximum Length: 100

  The name of the orchestration.
• OrchestrationNumber: string
  Title: Orchestration Number

  Read Only: true

  Maximum Length: 64

  The public unique identifier of the orchestration.
• OrchestrationStageId: integer (int64)
  Title: Orchestration Stage ID

  The unique identifier of the orchestration stage object.
• OrchestrationStageName: string
  Title: Stage Name

  Read Only: true

  Maximum Length: 100

  The name of the orchestration stage.
• OrchestrationStageNumber: string
  Title: Orchestration Stage Number

  Read Only: true

  Maximum Length: 64

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

  The unique identifier of the orchestration steps object.
• OrchestrationStepName: string
  Title: Orchestration Step Name

  Read Only: true

  Maximum Length: 100

  The name of orchestration step.
• OrchestrationStepNumber: string
  Title: Orchestration Step Number

  Read Only: true

  Maximum Length: 64

  The public unique identifier of the orchestration steps object.
• SourceObjectCode: string
  Title: Source Object Code

  Maximum Length: 100

  The language independent code of the transactional object. For example, Lead or Opportunity.
• SourceObjectId: integer (int64)
  Title: Source Object ID

  The unique identifier of the source object.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "ErrorDescription":{
            "title":"Error Description",
            "type":"string",
            "description":"The description of the error.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ErrorLogsId":{
            "title":"Error Logs ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration error logs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ErrorLogsNumber":{
            "title":"Error Logs Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier or alternate key of the orchestration error log.",
            "nullable":false,
            "x-queryable":true
        },
        "ErrorText":{
            "title":"Error Text",
            "maxLength":2000,
            "type":"string",
            "description":"Specifies the error call stack.",
            "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
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationName":{
            "title":"Orchestration Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the orchestration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationNumber":{
            "title":"Orchestration Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of the orchestration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationStageName":{
            "title":"Stage Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the orchestration stage.",
            "nullable":false,
            "readOnly":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
        },
        "OrchestrationStepId":{
            "title":"Orchestration Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration steps object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationStepName":{
            "title":"Orchestration Step Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of orchestration step.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStepNumber":{
            "title":"Orchestration Step Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of the orchestration steps object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Source Object Code",
            "maxLength":100,
            "type":"string",
            "description":"The language independent code of the transactional object. For example, Lead or Opportunity.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectId":{
            "title":"Source Object ID",
            "type":"integer",
            "description":"The unique identifier of the source object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : 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 : accounts-OrchestrationAssociations-StageObjectives-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row stage objectives.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the stage objectives was created.
• DisplaySequence: integer
  Title: Display Sequence

  The order in which the stage objectives are to be executed and shown in UI.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the stage objectives was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the stage objectives.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrchestrationAssociationId: integer (int64)
  Title: Orchestration Association ID

  The unique identifier of the orchestration association on stage objectives.
• OrchestrationId: integer (int64)
  Title: Orchestration ID

  The unique identifier of the orchestrations object on stage objectives.
• OrchestrationName: string
  Title: Orchestration Name

  Read Only: true

  Maximum Length: 100

  The name of the orchestration on stage objectives.
• OrchestrationNumber: string
  Title: Orchestration Number

  Read Only: true

  Maximum Length: 64

  The public unique identifier of the orchestration on stage objectives.
• OrchestrationStageDisplaySequence: integer (int32)
  Title: Display Sequence

  Read Only: true

  The order of the stages in the orchestration run time UIs.
• OrchestrationStageId: integer (int64)
  Title: Orchestration Stage ID

  The unique identifier of the orchestration stage object on stage objectives.
• OrchestrationStageName: string
  Title: Stage Name

  Read Only: true

  Maximum Length: 100

  The name of the orchestration stage on stage objectives.
• OrchestrationStageObjDescription: string
  Title: Objective Description

  Read Only: true

  Maximum Length: 2000

  The description text of the orchestration stage objective object.
• OrchestrationStageObjDisplaySequence: integer (int32)
  Title: Display Sequence

  Read Only: true

  The order of the objectives in the orchestration runtime UIs.
• OrchestrationStageObjectiveId: integer (int64)
  Title: Stage Objective ID

  The unique identifier of the orchestration stage objective which is part of stage objectives.
• OrchestrationStageObjName: string
  Title: Objective Name

  Read Only: true

  Maximum Length: 100

  The name of the Orchestration stage objective object.
• OrchestrationStageObjNumber: string
  Title: Stage Objective Number

  Read Only: true

  Maximum Length: 64

  The public unique identifier of the Orchestration stage objective object.
• RunTimeStageObjectiveId: integer (int64)
  Title: Run Time Stage Objective ID

  The unique identifier of the orchestration stage objective runtime object.
• RunTimeStageObjectiveNumber: string
  Title: Run Time Stage Objective Number

  Maximum Length: 64

  The public unique identifier of the orchestration stage objective runtime object.
• RunTimeStatus: string
  Title: Run Time Status

  Maximum Length: 30

  The run time status of the orchestration stage objective transition.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row stage objectives.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the stage objectives was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order in which the stage objectives are to be executed and shown in UI.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the stage objectives was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the stage objectives.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration association on stage objectives.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestrations object on stage objectives.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationName":{
            "title":"Orchestration Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the orchestration on stage objectives.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationNumber":{
            "title":"Orchestration Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of the orchestration on stage objectives.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchestrationStageDisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order of the stages in the orchestration run time UIs.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage object on stage objectives.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationStageName":{
            "title":"Stage Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the orchestration stage on stage objectives.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStageObjDescription":{
            "title":"Objective Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description text of the orchestration stage objective object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStageObjDisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order of the objectives in the orchestration runtime UIs.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "OrchestrationStageObjName":{
            "title":"Objective Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the Orchestration stage objective object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStageObjNumber":{
            "title":"Stage Objective Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of the Orchestration stage objective object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStageObjectiveId":{
            "title":"Stage Objective ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage objective which is part of stage objectives.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RunTimeStageObjectiveId":{
            "title":"Run Time Stage Objective ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage objective runtime object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RunTimeStageObjectiveNumber":{
            "title":"Run Time Stage Objective Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of the orchestration stage objective runtime object.",
            "nullable":false,
            "x-queryable":true
        },
        "RunTimeStatus":{
            "title":"Run Time Status",
            "maxLength":30,
            "type":"string",
            "description":"The run time status of the orchestration stage objective transition.",
            "nullable":true,
            "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"
            }
        }
    }
}

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 : accounts-OrchestrationAssociations-Stages-item-response

Type: object

Show Source

• CompletedObjsCnt: integer
  Title: Completed Objectives Count

  Number of completed objectives.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the stages.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the stages was created.
• CurrentStageFlag: boolean
  Title: Current Stage

  Maximum Length: 1

  Indicates whether it's the current INPROGRESS stage or the most recently updated stage.
• DisplaySequence: integer
  Title: Display Sequence

  The order in which the stages are to be executed and shown in the UI.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the stages was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the stages.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrchestrationAssociationId: integer (int64)
  Title: Orchestration Association ID

  The unique identifier of the orchestration association on stages .
• OrchestrationId: integer (int64)
  Title: Orchestration ID

  The unique identifier of the orchestrations object on stages.
• OrchestrationName: string
  Title: Orchestration Name

  Read Only: true

  Maximum Length: 100

  The name of the orchestration on stage.
• OrchestrationNumber: string
  Title: Orchestration Number

  Read Only: true

  Maximum Length: 64

  The public unique identifier of the orchestration on stages.
• OrchestrationStageDescription: string
  Title: Objective Description

  Read Only: true

  Maximum Length: 2000

  The description text of the orchestration stage object.
• OrchestrationStageId: integer (int64)
  Title: Orchestration Stage ID

  The unique identifier of the orchestration stage object on stages.
• OrchestrationStageName: string
  Title: Stage Name

  Read Only: true

  Maximum Length: 100

  The name of the orchestration stage on stages.
• OrchestrationStageNumber: string
  Title: Orchestration Stage Number

  Read Only: true

  Maximum Length: 64

  The public unique identifier of the orchestration stage object on stages.
• PendingObjectivesCount: integer
  Title: Pending Objectives Count

  Number of pending objectives.
• RuntimeStageId: integer (int64)
  Title: Run Time Stage ID

  The unique identifier of the orchestration stages runtime object.
• RuntimeStageNumber: string
  Title: Run Time Stage Number

  Maximum Length: 64

  The public unique identifier of the orchestration stages runtime object.
• RunTimeStatus: string
  Title: Run Time Status

  Maximum Length: 30

  The runtime status of the orchestration stages.
• SkippedNothelpfulObjsCnt: integer
  Title: Skipped Objectives Count

  Number of skipped or not helpful objectives.
• StageEndDate: string (date-time)
  Title: Stage End Date

  Specifies the date and time when the stage execution ends.
• StageStartDate: string (date-time)
  Title: Stage Start Date

  Specifies the date and time when the stage execution starts.
• StepsCountInExecutionPath: integer
  Title: Step Count in Execution Path

  Read Only: true

  Number of steps in the execution path for the orchestration stage.
• TotalObjsCnt: integer
  Title: Total Objectives Count

  Total number of objectives.

{
    "type":"object",
    "properties":{
        "CompletedObjsCnt":{
            "title":"Completed Objectives Count",
            "type":"integer",
            "description":"Number of completed objectives.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the stages.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the stages was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentStageFlag":{
            "title":"Current Stage",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether it's the current INPROGRESS stage or the most recently updated stage.",
            "nullable":true,
            "x-queryable":false
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order in which the stages are to be executed and shown in the UI.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the stages was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the stages.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration association on stages .",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestrations object on stages.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationName":{
            "title":"Orchestration Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the orchestration on stage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationNumber":{
            "title":"Orchestration Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of the orchestration on stages.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStageDescription":{
            "title":"Objective Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description text of the orchestration stage object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage object on stages.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationStageName":{
            "title":"Stage Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the orchestration stage on stages.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStageNumber":{
            "title":"Orchestration Stage Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of the orchestration stage object on stages.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PendingObjectivesCount":{
            "title":"Pending Objectives Count",
            "type":"integer",
            "description":"Number of pending objectives.",
            "nullable":true,
            "x-queryable":false
        },
        "RunTimeStatus":{
            "title":"Run Time Status",
            "maxLength":30,
            "type":"string",
            "description":"The runtime status of the orchestration stages.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RuntimeStageId":{
            "title":"Run Time Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stages runtime object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RuntimeStageNumber":{
            "title":"Run Time Stage Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of the orchestration stages runtime object.",
            "nullable":false,
            "x-queryable":true
        },
        "SkippedNothelpfulObjsCnt":{
            "title":"Skipped Objectives Count",
            "type":"integer",
            "description":"Number of skipped or not helpful objectives.",
            "nullable":true,
            "x-queryable":false
        },
        "StageEndDate":{
            "title":"Stage End Date",
            "type":"string",
            "description":"Specifies the date and time when the stage execution ends.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "StageStartDate":{
            "title":"Stage Start Date",
            "type":"string",
            "description":"Specifies the date and time when the stage execution starts.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "StepsCountInExecutionPath":{
            "title":"Step Count in Execution Path",
            "type":"integer",
            "description":"Number of steps in the execution path for the orchestration stage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TotalObjsCnt":{
            "title":"Total Objectives Count",
            "type":"integer",
            "description":"Total number of objectives.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : accounts-OrchestrationAssociations-Steps-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the steps.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the step was created.
• CurrentStepFlag: boolean
  Title: Current Step

  Maximum Length: 1

  Indicates whether it's the current INPROGRESS step or the most recently updated step.
• DisplaySequence: integer
  Title: Display Sequence

  The order in which the stage objectives to be executed or shown back in UI. The display sequence of the steps.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the steps was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the steps.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrchestrationAssociationId: integer (int64)
  Title: Orchestration Association ID

  The unique identifier of the orchestration association on steps.
• OrchestrationId: integer (int64)
  Title: Orchestration ID

  The unique identifier of the orchestrations object on steps.
• OrchestrationName: string
  Title: Orchestration Name

  Read Only: true

  Maximum Length: 100

  The name of the orchestration on steps.
• OrchestrationNumber: string
  Title: Orchestration Number

  Read Only: true

  Maximum Length: 64

  The public unique identifier of the orchestration on steps.
• OrchestrationStageId: integer (int64)
  Title: Orchestration Stage ID

  The unique identifier of the orchestration stage object on steps.
• OrchestrationStageName: string
  Title: Stage Name

  Read Only: true

  Maximum Length: 100

  The name of the orchestration stage on steps.
• OrchestrationStageNumber: string
  Title: Orchestration Stage Number

  Read Only: true

  Maximum Length: 64

  The public unique identifier of the orchestration stage object on steps.
• OrchestrationStepId: integer (int64)
  Title: Orchestration Step ID

  The unique identifier of the orchestration steps object on steps.
• OrchestrationStepName: string
  Title: Orchestration Step Name

  Read Only: true

  Maximum Length: 100

  The name of orchestration step on steps object.
• OrchestrationStepNumber: string
  Title: Orchestration Step Number

  Read Only: true

  Maximum Length: 64

  The public unique identifier of the orchestration steps object on steps.
• RunTimeStatus: string
  Title: Run Time Status

  Maximum Length: 30

  The runtime status of the orchestration steps.
• RunTimeStepId: integer (int64)
  Title: Run Time Step ID

  The unique identifier of the orchestration steps runtime object.
• RunTimeStepNumber: string
  Title: Run Time Step Number

  Maximum Length: 64

  The public unique identifier or alternate key of the orchestration steps runtime object.
• StepEndDate: string (date-time)
  Title: Step End Date

  Specifies the date and time when the step execution ends.
• StepStartDate: string (date-time)
  Title: Step Start Date

  Specifies the date and time when the step execution starts.
• StepTemplateId: integer (int64)
  Title: Step Template ID

  Read Only: true

  The unique identifier of the step template.
• StepTemplateStepName: string
  Title: Step Name Within Step Template

  Read Only: true

  Maximum Length: 100

  The name of the step within the step template resource.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the steps.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the step was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentStepFlag":{
            "title":"Current Step",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether it's the current INPROGRESS step or the most recently updated step.",
            "nullable":true,
            "x-queryable":false
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order in which the stage objectives to be executed or shown back in UI. The display sequence of the steps.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the steps was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the steps.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration association on steps.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestrations object on steps.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationName":{
            "title":"Orchestration Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the orchestration on steps.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationNumber":{
            "title":"Orchestration Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of the orchestration on steps.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage object on steps.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationStageName":{
            "title":"Stage Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the orchestration stage on steps.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStageNumber":{
            "title":"Orchestration Stage Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of the orchestration stage object on steps.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStepId":{
            "title":"Orchestration Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration steps object on steps.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationStepName":{
            "title":"Orchestration Step Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of orchestration step on steps object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStepNumber":{
            "title":"Orchestration Step Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of the orchestration steps object on steps.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "RunTimeStatus":{
            "title":"Run Time Status",
            "maxLength":30,
            "type":"string",
            "description":"The runtime status of the orchestration steps.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RunTimeStepId":{
            "title":"Run Time Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration steps runtime object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RunTimeStepNumber":{
            "title":"Run Time Step Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier or alternate key of the orchestration steps runtime object.",
            "nullable":false,
            "x-queryable":true
        },
        "StepEndDate":{
            "title":"Step End Date",
            "type":"string",
            "description":"Specifies the date and time when the step execution ends.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "StepStartDate":{
            "title":"Step Start Date",
            "type":"string",
            "description":"Specifies the date and time when the step execution starts.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "StepTemplateId":{
            "title":"Step Template ID",
            "type":"integer",
            "description":"The unique identifier of the step template.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "StepTemplateStepName":{
            "title":"Step Name Within Step Template",
            "maxLength":100,
            "type":"string",
            "description":"The name of the step within the step template resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : accounts-OrchestrationAssociations-StepsInExecutionPath-item-response

Type: object

Show Source

• ContainMultipleTasks: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the step contains multiple tasks.
• CurrentStepFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether it's the current INPROGRESS step or the most recently updated step.
• DisplaySequence: integer (int32)
  Read Only: true

  The order in which the stage objectives to be executed or shown back in UI. The display sequence of the steps.
• ExecutionMethod: string
  Read Only: true

  Maximum Length: 30

  The execution type for the orchestration step. The possible values are Manual and Automatic.
• FulfillsObjectiveCnt: integer
  Read Only: true

  The count of the orchestration objective.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrchestrationAssocId: integer (int64)
  Read Only: true

  The unique identifier of the orchestration association.
• OrchestrationStageId: integer (int64)
  Read Only: true

  The unique identifier of the orchestration stage object.
• OrchestrationStageObjId: integer (int64)
  Read Only: true

  The unique identifier of the orchestration stage objective which is part of stage objectives.
• OrchestrationStepId: integer (int64)
  Read Only: true

  The unique identifier of the orchestration steps object.
• OrchestrationStepName: string
  Read Only: true

  Maximum Length: 100

  The name of orchestration step.
• RunTimeStatus: string
  Read Only: true

  Maximum Length: 30

  The runtime status of the orchestration steps.
• StepEndDate: string (date-time)
  Read Only: true

  Specifies the date and time when the step execution ends.
• StepStartDate: string (date-time)
  Read Only: true

  Specifies the date and time when the step execution starts.
• StepSuggestionText: string
  Read Only: true

  Maximum Length: 2000

  The suggestion text of the orchestration step.
• StepType: string
  Read Only: true

  Maximum Length: 30

  Step Type

{
    "type":"object",
    "properties":{
        "ContainMultipleTasks":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the step contains multiple tasks.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CurrentStepFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether it's the current INPROGRESS step or the most recently updated step.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DisplaySequence":{
            "type":"integer",
            "description":"The order in which the stage objectives to be executed or shown back in UI. The display sequence of the steps.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "ExecutionMethod":{
            "maxLength":30,
            "type":"string",
            "description":"The execution type for the orchestration step. The possible values are Manual and Automatic.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FulfillsObjectiveCnt":{
            "type":"integer",
            "description":"The count of the orchestration objective.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationAssocId":{
            "type":"integer",
            "description":"The unique identifier of the orchestration association.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OrchestrationStageId":{
            "type":"integer",
            "description":"The unique identifier of the orchestration stage object.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationStageObjId":{
            "type":"integer",
            "description":"The unique identifier of the orchestration stage objective which is part of stage objectives.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationStepId":{
            "type":"integer",
            "description":"The unique identifier of the orchestration steps object.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OrchestrationStepName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of orchestration step.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RunTimeStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The runtime status of the orchestration steps.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StepEndDate":{
            "type":"string",
            "description":"Specifies the date and time when the step execution ends.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StepStartDate":{
            "type":"string",
            "description":"Specifies the date and time when the step execution starts.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StepSuggestionText":{
            "maxLength":2000,
            "type":"string",
            "description":"The suggestion text of the orchestration step.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StepType":{
            "maxLength":30,
            "type":"string",
            "description":"Step Type",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : accounts-OrchestrationAssociations-StepTransitions-item-response

Type: object

Show Source

• ActivityAppointmentStatusCode: string
  Title: Appointment Status

  Read Only: true

  Maximum Length: 30

  The status of the appointment.
• ActivityDescription: string (byte)
  Title: Description

  Read Only: true

  A text field for capturing some descriptive information about the activity.
• ActivityDueDate: string (date)
  Title: Due Date

  Read Only: true

  The date the task activity is due to be completed.
• ActivityEndDate: string (date-time)
  Title: End Date

  Read Only: true

  The end date and time of an appointment, or the completion time of a task.
• ActivityId: integer (int64)
  Title: Activity ID

  The unique identifier of the activity ID.
• ActivityNumber: string
  Title: Activity Number

  Read Only: true

  Maximum Length: 64

  The alternate identifier of the activity.
• ActivityOwnerId: integer (int64)
  Title: Owner ID

  Read Only: true

  The primary resource on the activity. Supports resources only.
• ActivityOwnerPartyName: string
  Title: Owner

  Read Only: true

  Maximum Length: 360

  Name of the party.
• ActivityPartialDescription: string
  Title: Short Description

  Read Only: true

  Maximum Length: 4000

  A column that stores the first 4000 characters of activity description.
• ActivitySMARTActionContext: string
  Title: Smart Action Context

  Read Only: true

  Maximum Length: 4000

  Stores metadata needed for smart action.
• ActivitySMARTActionId: integer (int64)
  Title: Smart Action ID

  Read Only: true

  The smart action Identifier. Foreign key from zca_user_action.
• ActivityStartDate: string (date-time)
  Title: Start Date

  Read Only: true

  The start date and time of an appointment or a task. Defaulted to null for an appointment and defaulted to creation date time for a task.
• ActivitySubject: string
  Title: Subject

  Read Only: true

  Maximum Length: 500

  The subject of the activity.
• ActivityTaskStatusCode: string
  Title: Status

  Read Only: true

  Maximum Length: 30

  Status of the activity. Defaulted to NOT_STARTED.
• ActivityWebConferenceId: string
  Title: Web Conference ID

  Read Only: true

  Maximum Length: 255

  The unique identifier of the web conference.
• ActivityWebConferenceURL: string
  Title: Web Conference URL

  Read Only: true

  Maximum Length: 2000

  The web conference join URL.
• AllowSkipFlag: boolean
  Title: Allow Step Skipping

  Read Only: true

  Maximum Length: 1

  Default Value: true

  Indicates whether or not to show skip or thumbs down icon in the guidance primary or secondary banner.
• Comments: string
  Title: Comments

  Maximum Length: 2000

  Specifies the brief comments required for runtime step transition row.
• ConversationId: integer (int64)
  Title: Conversation ID

  The unique identifier of conversation message.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the step transitions.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the step transitions was created.
• EmailType: string
  Title: Email Type

  Maximum Length: 30

  The type of the email to which the step transitions associated with.
• ExitOrchestrationFlag: boolean
  Title: Exit Orchestration

  Read Only: true

  Maximum Length: 1

  Flag that indicates whether or not to exit the orchestration when a stop step occurs.
• IATemplateName: string
  Title: Authoring Interview Template Name

  Read Only: true

  Maximum Length: 255

  The name of the authoring interview template.
• IATemplateValue: string
  Title: IA Template Value

  Read Only: true

  Maximum Length: 100

  The name of the intelligent advisor guide template.
• InboundConvMsgId: integer (int64)
  Title: Inbound Conversation Message ID

  The unique identifier of inbound conversation message.
• InteractionId: integer (int64)
  Title: Interaction ID

  The unique identifier of interaction.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the step transitions was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the step transition.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrchestrationAssociationId: integer (int64)
  Title: Orchestration Association ID

  The unique identifier of the orchestration association on step transitions.
• OrchestrationAssociationNumber: string
  Title: Orchestration Association Number

  Read Only: true

  Maximum Length: 64

  The alternate unique identifier of the orchestration association on step transitions.
• OrchestrationId: integer (int64)
  Title: Orchestration ID

  The unique identifier of the orchestrations object on step transitions.
• OrchestrationName: string
  Title: Orchestration Name

  Read Only: true

  Maximum Length: 100

  The name of the orchestration on step transitions.
• OrchestrationNumber: string
  Title: Orchestration Number

  Read Only: true

  Maximum Length: 64

  The public unique identifier of the orchestration on step transitions.
• OrchestrationStageId: integer (int64)
  Title: Orchestration Stage ID

  The unique identifier of the orchestration stage object on step transitions.
• OrchestrationStageName: string
  Title: Stage Name

  Read Only: true

  Maximum Length: 100

  The name of the orchestration stage on step transitions.
• OrchestrationStageNumber: string
  Title: Orchestration Stage Number

  Read Only: true

  Maximum Length: 64

  The public unique identifier of the orchestration stage object on step transitions.
• OrchestrationStepId: integer (int64)
  Title: Orchestration Step ID

  The unique identifier of the orchestration steps object on step transitions.
• OrchestrationStepName: string
  Title: Orchestration Step Name

  Read Only: true

  Maximum Length: 100

  The name of orchestration step on step transitions object.
• OrchestrationStepNumber: string
  Title: Orchestration Step Number

  Read Only: true

  Maximum Length: 64

  The public unique identifier of the orchestration steps object on step transitions.
• OrchestrationStepTasksId: integer (int64)
  Title: Orchestration Step Tasks ID

  Unique identifier for the orchestration step tasks.
• OrchestrationStepType: string
  Title: Step Type

  Read Only: true

  Maximum Length: 30

  The type of step.
• OrchStepTransitionFlag: boolean
  Title: Current Step Transition

  Maximum Length: 1

  Indicates whether it's the current INPROGRESS step transition or the most recently updated step transition row.
• OutboundConvMsgId: integer (int64)
  Title: Outbound Conversation Message ID

  The unique identifier of outbound conversation message.
• RefreshPageFlag: boolean
  Title: Refresh Page

  Maximum Length: 1

  Specifies whether or not to refresh the whole page before surfacing the current step in the runtime UI.
• StepDisplaySequence: integer
  Title: Display Sequence

  Read Only: true

  The order of the steps in the orchestration administrator runtime UIs.
• StepSuggestionText: string
  Title: Step Suggestion Text

  Read Only: true

  Maximum Length: 2000

  The suggestion text of the orchestration step.
• StepTaskDisplaySequence: integer (int32)
  Title: Display Sequence

  Read Only: true

  The order of the steps in the orchestration administrator runtime UIs.
• StepTemplateId: integer (int64)
  Title: Step Template ID

  Read Only: true

  The unique identifier of the step template.
• StepTemplateStepName: string
  Title: Step Template Name

  Read Only: true

  Maximum Length: 100

  The name of the step within the step template resource.
• StepTransitionId: integer (int64)
  Title: Step Transition ID

  The unique identifier of the orchestration step transition object.
• StepTransitionNumber: string
  Title: Step Transition Number

  Maximum Length: 64

  The public unique identifier of the orchestration step transition object.
• StepType: string
  Title: Step Type

  Maximum Length: 30

  The type of the step to which the step transitions correspond to.
• SuccessCriteriaEvalFlag: boolean
  Title: Success Criteria Evaluation Flag

  Maximum Length: 1

  Specifies the success criteria evaluation result for the step.
• TransitionDueDateTime: string (date-time)
  Title: Transition Due Date Time

  The date and timestamp when the step transition is due.
• TransitionEndDateTime: string (date-time)
  Title: Transition End Date Time

  The date and timestamp when the step transition ended.
• TransitionStartDateTime: string (date-time)
  Title: Transition Start Date Time

  The date and timestamp when the step transition started.
• TransitionStatus: string
  Title: Transition Status

  Maximum Length: 30

  The status of the orchestration step transition.
• WrapUpId: integer (int64)
  Title: Wrap-up ID

  The unique identifier of the wrap up.

{
    "type":"object",
    "properties":{
        "ActivityAppointmentStatusCode":{
            "title":"Appointment Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the appointment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivityDescription":{
            "title":"Description",
            "type":"string",
            "description":"A text field for capturing some descriptive information about the activity.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivityDueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The date the task activity is due to be completed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivityEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date and time of an appointment, or the completion time of a task.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"The unique identifier of the activity ID.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ActivityNumber":{
            "title":"Activity Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate identifier of the activity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivityOwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The primary resource on the activity. Supports resources only.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ActivityOwnerPartyName":{
            "title":"Owner",
            "maxLength":360,
            "type":"string",
            "description":"Name of the party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivityPartialDescription":{
            "title":"Short Description",
            "maxLength":4000,
            "type":"string",
            "description":"A column that stores the first 4000 characters of activity description.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivitySMARTActionContext":{
            "title":"Smart Action Context",
            "maxLength":4000,
            "type":"string",
            "description":"Stores metadata needed for smart action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivitySMARTActionId":{
            "title":"Smart Action ID",
            "type":"integer",
            "description":"The smart action Identifier. Foreign key from zca_user_action.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ActivityStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date and time of an appointment or a task. Defaulted to null for an appointment and defaulted to creation date time for a task.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivitySubject":{
            "title":"Subject",
            "maxLength":500,
            "type":"string",
            "description":"The subject of the activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivityTaskStatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the activity. Defaulted to NOT_STARTED.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivityWebConferenceId":{
            "title":"Web Conference ID",
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of the web conference.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivityWebConferenceURL":{
            "title":"Web Conference URL",
            "maxLength":2000,
            "type":"string",
            "description":"The web conference join URL.",
            "nullable":true,
            "readOnly":true,
            "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,
            "readOnly":true,
            "default":true,
            "x-queryable":false
        },
        "Comments":{
            "title":"Comments",
            "maxLength":2000,
            "type":"string",
            "description":"Specifies the brief comments required for runtime step transition row.",
            "nullable":true,
            "x-queryable":false
        },
        "ConversationId":{
            "title":"Conversation ID",
            "type":"integer",
            "description":"The unique identifier of conversation message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the step transitions.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the step transitions was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailType":{
            "title":"Email Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the email to which the step transitions associated with.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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,
            "readOnly":true,
            "x-queryable":false
        },
        "IATemplateName":{
            "title":"Authoring Interview Template Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the authoring interview template.",
            "nullable":true,
            "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,
            "readOnly":true,
            "x-queryable":false
        },
        "InboundConvMsgId":{
            "title":"Inbound Conversation Message ID",
            "type":"integer",
            "description":"The unique identifier of inbound conversation message.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "InteractionId":{
            "title":"Interaction ID",
            "type":"integer",
            "description":"The unique identifier of interaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the step transitions was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the step transition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchStepTransitionFlag":{
            "title":"Current Step Transition",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether it's the current INPROGRESS step transition or the most recently updated step transition row.",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration association on step transitions.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationAssociationNumber":{
            "title":"Orchestration Association Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate unique identifier of the orchestration association on step transitions.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestrations object on step transitions.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationName":{
            "title":"Orchestration Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the orchestration on step transitions.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationNumber":{
            "title":"Orchestration Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of the orchestration on step transitions.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage object on step transitions.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationStageName":{
            "title":"Stage Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the orchestration stage on step transitions.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStageNumber":{
            "title":"Orchestration Stage Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of the orchestration stage object on step transitions.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStepId":{
            "title":"Orchestration Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration steps object on step transitions.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationStepName":{
            "title":"Orchestration Step Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of orchestration step on step transitions object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStepNumber":{
            "title":"Orchestration Step Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of the orchestration steps object on step transitions.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStepTasksId":{
            "title":"Orchestration Step Tasks ID",
            "type":"integer",
            "description":"Unique identifier for the orchestration step tasks.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationStepType":{
            "title":"Step Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of step.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OutboundConvMsgId":{
            "title":"Outbound Conversation Message ID",
            "type":"integer",
            "description":"The unique identifier of outbound conversation message.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RefreshPageFlag":{
            "title":"Refresh Page",
            "maxLength":1,
            "type":"boolean",
            "description":"Specifies whether or not to refresh the whole page before surfacing the current step in the runtime UI.",
            "nullable":true,
            "x-queryable":false
        },
        "StepDisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order of the steps in the orchestration administrator runtime UIs.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "StepSuggestionText":{
            "title":"Step Suggestion Text",
            "maxLength":2000,
            "type":"string",
            "description":"The suggestion text of the orchestration step.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StepTaskDisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order of the steps in the orchestration administrator runtime UIs.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "StepTemplateId":{
            "title":"Step Template ID",
            "type":"integer",
            "description":"The unique identifier of the step template.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "StepTemplateStepName":{
            "title":"Step Template Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the step within the step template resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "StepTransitionId":{
            "title":"Step Transition ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration step transition object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StepTransitionNumber":{
            "title":"Step Transition Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of the orchestration step transition object.",
            "nullable":false,
            "x-queryable":true
        },
        "StepType":{
            "title":"Step Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the step to which the step transitions correspond to.",
            "nullable":false,
            "x-queryable":true
        },
        "SuccessCriteriaEvalFlag":{
            "title":"Success Criteria Evaluation Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Specifies the success criteria evaluation result for the step.",
            "nullable":true,
            "x-queryable":false
        },
        "TransitionDueDateTime":{
            "title":"Transition Due Date Time",
            "type":"string",
            "description":"The date and timestamp when the step transition is due.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "TransitionEndDateTime":{
            "title":"Transition End Date Time",
            "type":"string",
            "description":"The date and timestamp when the step transition ended.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "TransitionStartDateTime":{
            "title":"Transition Start Date Time",
            "type":"string",
            "description":"The date and timestamp when the step transition started.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "TransitionStatus":{
            "title":"Transition Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the orchestration step transition.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "WrapUpId":{
            "title":"Wrap-up ID",
            "type":"integer",
            "description":"The unique identifier of the wrap up.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

AssociationStatusCodeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_ORCH_ASSOC_RT_STATUS

The following properties are defined on the LOV link relation:

• Source Attribute: AssociationStatusCode; Target Attribute: LookupCode
• Display Attribute: Meaning

ErrorLogs

Operation: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/OrchestrationAssociations/{accounts_OrchestrationAssociations_Id}/child/ErrorLogs

Parameters:

• PartyNumber: $request.path.PartyNumber
• accounts_OrchestrationAssociations_Id: $request.path.accounts_OrchestrationAssociations_Id

The error logs resource is used to view the error details.

PerformActionVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_ORCH_RT_PERFORM_ACTION

The following properties are defined on the LOV link relation:

• Source Attribute: PerformAction; Target Attribute: LookupCode
• Display Attribute: Meaning

StageObjectives

Operation: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/OrchestrationAssociations/{accounts_OrchestrationAssociations_Id}/child/StageObjectives

Parameters:

• PartyNumber: $request.path.PartyNumber
• accounts_OrchestrationAssociations_Id: $request.path.accounts_OrchestrationAssociations_Id

The stage objectives resource is used to view the stage objectives of the orchestration association.

Stages

Operation: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/OrchestrationAssociations/{accounts_OrchestrationAssociations_Id}/child/Stages

Parameters:

• PartyNumber: $request.path.PartyNumber
• accounts_OrchestrationAssociations_Id: $request.path.accounts_OrchestrationAssociations_Id

The stages resource is used to view the stage of the orchestration association.

StepTransitions

Operation: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/OrchestrationAssociations/{accounts_OrchestrationAssociations_Id}/child/StepTransitions

Parameters:

• PartyNumber: $request.path.PartyNumber
• accounts_OrchestrationAssociations_Id: $request.path.accounts_OrchestrationAssociations_Id

The step transitions resource is used to view the step transitions of the orchestration association.

Steps

Operation: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/OrchestrationAssociations/{accounts_OrchestrationAssociations_Id}/child/Steps

Parameters:

• PartyNumber: $request.path.PartyNumber
• accounts_OrchestrationAssociations_Id: $request.path.accounts_OrchestrationAssociations_Id

The steps resource is used to view the steps of the orchestration association.

StepsInExecutionPath

Operation: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/OrchestrationAssociations/{accounts_OrchestrationAssociations_Id}/child/StepsInExecutionPath

Parameters:

• PartyNumber: $request.path.PartyNumber
• accounts_OrchestrationAssociations_Id: $request.path.accounts_OrchestrationAssociations_Id

The Steps in the Execution Path resource is used to view all the steps including future steps in the execution path of the orchestration association.

Back to Top