Jump to

• Request
• Response

Get an orchestration association

get

/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}

Request

Path Parameters

• OptyNumber(required): string
  The unique alternate identifier for the opportunity.
• OrchestrationAssociationNumber(required): string
  The alternate identifier of the orchestration association.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to 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 : opportunities-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.
• CompletedObjsCnt: integer
  Title: Completed Objectives Count

  Read Only: true

  The count of completed objectives.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date when the record was created.
• 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 error logs associated to the orchestration associations.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  The link relations associated with the resource instance.
• NextStepId: integer (int64)
  Title: Next Step ID

  Read Only: true

  The unique identifier of the next step to be executed as part of the current Orchestration.
• NextStepSmartActionId: integer (int64)
  Title: Next Step Smart Action ID

  Read Only: true

  The smart action identifier of the next step to be executed as part of 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 identifier of the orchestration association.
• OrchestrationId: integer (int64)
  Title: Orchestration ID

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

  Read Only: true

  Maximum Length: 100

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

  Read Only: true

  Maximum Length: 64

  The alternate identifier of the orchestration object.
• PendingObjectivesCount: integer
  Title: Pending Objectives Count

  Read Only: true

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

  Maximum Length: 30

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

  Read Only: true

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

  Maximum Length: 100

  The language independent object code.
• SourceObjectId: integer (int64)
  Title: Source Object ID

  The unique identifier for the source object code.
• 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 Execution Path
  Title: Steps In Execution Path

  The steps in execution path resource is used to view all the steps including future steps 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

  The total number of objectives.

{
    "type":"object",
    "properties":{
        "Steps":{
            "title":"Steps",
            "type":"array",
            "description":"The steps resource is used to view the steps of the orchestration association.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OrchestrationAssociations-Steps-item-response"
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SkippedNothelpfulObjsCnt":{
            "title":"Skipped Objectives Count",
            "type":"integer",
            "description":"The count of skipped or not helpful objectives.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationAssociationNumber":{
            "title":"Orchestration Association Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration association.",
            "nullable":false,
            "x-queryable":true
        },
        "NextStepSmartActionId":{
            "title":"Next Step Smart Action ID",
            "type":"integer",
            "description":"The smart action identifier of the next step to be executed as part of the current Orchestration.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CompletedObjsCnt":{
            "title":"Completed Objectives Count",
            "type":"integer",
            "description":"The count of completed objectives.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NextStepId":{
            "title":"Next Step ID",
            "type":"integer",
            "description":"The unique identifier of the next step to be executed as part of the current Orchestration.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "TotalObjsCnt":{
            "title":"Total Objectives Count",
            "type":"integer",
            "description":"The total number of objectives.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceObjectCode":{
            "title":"Source Object Code",
            "maxLength":"100",
            "type":"string",
            "description":"The language independent object code.",
            "nullable":false,
            "x-queryable":true
        },
        "AssociationStatusCode":{
            "title":"Association Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the association.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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/opportunities-OrchestrationAssociations-StepTransitions-item-response"
            }
        },
        "PendingObjectivesCount":{
            "title":"Pending Objectives Count",
            "type":"integer",
            "description":"Number of pending objectives.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ErrorLogs":{
            "title":"Error Logs",
            "type":"array",
            "description":"The error logs resource is used to view error logs associated to the orchestration associations.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OrchestrationAssociations-ErrorLogs-item-response"
            }
        },
        "OrchestrationName":{
            "title":"Orchestration Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of orchestration object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PerformAction":{
            "title":"Action to Perform",
            "maxLength":"30",
            "type":"string",
            "description":"The action that user can perform on this orchestration association.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Stages":{
            "title":"Stages",
            "type":"array",
            "description":"The stages resource is used to view the stage of the orchestration association.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OrchestrationAssociations-Stages-item-response"
            }
        },
        "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
        },
        "StepsInExecutionPath":{
            "title":"Steps In Execution Path",
            "type":"array",
            "description":"The steps in execution path resource is used to view all the steps including future steps of the orchestration association.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OrchestrationAssociations-StepsInExecutionPath-item-response"
            }
        },
        "OrchestrationNumber":{
            "title":"Orchestration Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceObjectId":{
            "title":"Source Object ID",
            "type":"integer",
            "description":"The unique identifier for the source object code.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "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
        },
        "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/opportunities-OrchestrationAssociations-StageObjectives-item-response"
            }
        },
        "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
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Error Logs

Type: array

Title: Error Logs

The error logs resource is used to view error logs associated to the orchestration associations.

Show Source

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

{
    "title":"Error Logs",
    "type":"array",
    "description":"The error logs resource is used to view error logs associated to the orchestration associations.",
    "items":{
        "$ref":"#/components/schemas/opportunities-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 opportunities-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/opportunities-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 opportunities-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/opportunities-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 opportunities-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/opportunities-OrchestrationAssociations-Steps-item-response"
    }
}

Nested Schema : Steps In Execution Path

Type: array

Title: Steps In Execution Path

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

Show Source

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

{
    "title":"Steps In Execution Path",
    "type":"array",
    "description":"The steps in execution path resource is used to view all the steps including future steps of the orchestration association.",
    "items":{
        "$ref":"#/components/schemas/opportunities-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 opportunities-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/opportunities-OrchestrationAssociations-StepTransitions-item-response"
    }
}

Nested Schema : opportunities-OrchestrationAssociations-ErrorLogs-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date when the record was created.
• 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 alternate identifier of the orchestration error logs.
• ErrorText: string
  Title: Error Text

  Maximum Length: 2000

  The brief error details.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

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

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

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

  Read Only: true

  Maximum Length: 100

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

  Read Only: true

  Maximum Length: 64

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

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

  Read Only: true

  Maximum Length: 100

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

  Read Only: true

  Maximum Length: 64

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

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

  Read Only: true

  Maximum Length: 100

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

  Read Only: true

  Maximum Length: 64

  The alternate identifier of the orchestration step object.
• SourceObjectCode: string
  Title: Source Object Code

  Maximum Length: 100

  The language independent object code.
• SourceObjectId: integer (int64)
  Title: Source Object ID

  The unique identifier for the source object code.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ErrorDescription":{
            "title":"Error Description",
            "type":"string",
            "description":"The description of the error.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchestrationStageNumber":{
            "title":"Orchestration Stage Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration stage object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorText":{
            "title":"Error Text",
            "maxLength":"2000",
            "type":"string",
            "description":"The brief error details.",
            "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
        },
        "OrchestrationName":{
            "title":"Orchestration Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of orchestration object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrchestrationStepId":{
            "title":"Orchestration Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration step object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrchestrationStepNumber":{
            "title":"Orchestration Step Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration step object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchestrationStageName":{
            "title":"Stage Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of orchestration stage object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStepName":{
            "title":"Orchestration Step Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of orchestration step.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationNumber":{
            "title":"Orchestration Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceObjectId":{
            "title":"Source Object ID",
            "type":"integer",
            "description":"The unique identifier for the source object code.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Source Object Code",
            "maxLength":"100",
            "type":"string",
            "description":"The language independent object code.",
            "nullable":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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ErrorLogsNumber":{
            "title":"Error Logs Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration error logs.",
            "nullable":false,
            "x-queryable":true
        },
        "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
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : 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 : opportunities-OrchestrationAssociations-StageObjectives-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date when the record was created.
• DisplaySequence: integer
  Title: Display Sequence

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

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

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

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

  Read Only: true

  Maximum Length: 100

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

  Read Only: true

  Maximum Length: 64

  The alternate identifier of the orchestration object.
• OrchestrationStageDisplaySequence: integer (int32)
  Title: Display Sequence

  Read Only: true

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

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

  Read Only: true

  Maximum Length: 100

  The name of the orchestration stage object.
• 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 stages in the orchestration admin run time UIs.
• OrchestrationStageObjectiveId: integer (int64)
  Title: Stage Objective ID

  The unique identifier of the orchestration stage objective object.
• 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 alternate identifier of the orchestration stage objective object.
• RunTimeStageObjectiveId: integer (int64)
  Title: Run Time Stage Objective ID

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

  Maximum Length: 64

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

  Maximum Length: 30

  The status of the orchestration stage objective transition.

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : opportunities-OrchestrationAssociations-Stages-item-response

Type: object

Show Source

• CompletedObjsCnt: integer
  Title: Completed Objectives Count

  The count of completed objectives.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date when the record was created.
• 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 stage objectives are to be executed or shown back in UI.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

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

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

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

  Read Only: true

  Maximum Length: 100

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

  Read Only: true

  Maximum Length: 64

  The alternate identifier of the orchestration object.
• 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.
• OrchestrationStageName: string
  Title: Stage Name

  Read Only: true

  Maximum Length: 100

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

  Read Only: true

  Maximum Length: 64

  The alternate identifier of the orchestration stage object.
• 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 alternate identifier of the orchestration stages runtime object.
• RunTimeStatus: string
  Title: Run Time Status

  Maximum Length: 30

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

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

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

  The date and time when the stage execution ends.
• 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

  The total number of objectives.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SkippedNothelpfulObjsCnt":{
            "title":"Skipped Objectives Count",
            "type":"integer",
            "description":"The count of skipped or not helpful objectives.",
            "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
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order in which the stage objectives are to be executed or shown back in UI.",
            "nullable":true,
            "x-queryable":true
        },
        "OrchestrationStageName":{
            "title":"Stage Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the orchestration stage object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CompletedObjsCnt":{
            "title":"Completed Objectives Count",
            "type":"integer",
            "description":"The count of completed objectives.",
            "nullable":true,
            "x-queryable":false
        },
        "TotalObjsCnt":{
            "title":"Total Objectives Count",
            "type":"integer",
            "description":"The total number of objectives.",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RuntimeStageNumber":{
            "title":"Run Time Stage Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration stages runtime object.",
            "nullable":false,
            "x-queryable":true
        },
        "OrchestrationStageDescription":{
            "title":"Objective Description",
            "maxLength":"2000",
            "type":"string",
            "description":"The description text of the orchestration stage object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PendingObjectivesCount":{
            "title":"Pending Objectives Count",
            "type":"integer",
            "description":"Number of pending objectives.",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationStageNumber":{
            "title":"Orchestration Stage Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration stage object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationName":{
            "title":"Orchestration Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of orchestration object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "StageStartDate":{
            "title":"Stage Start Date",
            "type":"string",
            "description":"The date and time when the stage execution ends.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RunTimeStatus":{
            "title":"Run Time Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the orchestration stages.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "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
        },
        "OrchestrationNumber":{
            "title":"Orchestration Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "StageEndDate":{
            "title":"Stage End Date",
            "type":"string",
            "description":"The date and time when the stage execution starts.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "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
        },
        "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
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : opportunities-OrchestrationAssociations-Steps-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date when the record was created.
• 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 steps are to be executed or shown back in UI.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

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

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

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

  Read Only: true

  Maximum Length: 100

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

  Read Only: true

  Maximum Length: 64

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

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

  Read Only: true

  Maximum Length: 100

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

  Read Only: true

  Maximum Length: 64

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

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

  Read Only: true

  Maximum Length: 100

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

  Read Only: true

  Maximum Length: 64

  The alternate identifier of the orchestration step object.
• RunTimeStatus: string
  Title: Run Time Status

  Maximum Length: 30

  The run time status of the orchestration stage objective transition.
• 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 alternate identifier of the orchestration steps runtime object.
• StepEndDate: string (date-time)
  Title: Step End Date

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

  The date and time when the step execution starts.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchestrationStageNumber":{
            "title":"Orchestration Stage Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration stage object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order in which the steps are to be executed or shown back in UI.",
            "nullable":true,
            "x-queryable":true
        },
        "OrchestrationName":{
            "title":"Orchestration Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of orchestration object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrchestrationStepId":{
            "title":"Orchestration Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration step object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StepEndDate":{
            "title":"Step End Date",
            "type":"string",
            "description":"The date and time when the step execution ends.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationStepNumber":{
            "title":"Orchestration Step Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration step object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "RunTimeStatus":{
            "title":"Run Time Status",
            "maxLength":"30",
            "type":"string",
            "description":"The run time status of the orchestration stage objective transition.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrchestrationStageName":{
            "title":"Stage Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the orchestration stage object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStepName":{
            "title":"Orchestration Step Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of orchestration step.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "RunTimeStepNumber":{
            "title":"Run Time Step Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration steps runtime object.",
            "nullable":false,
            "x-queryable":true
        },
        "StepStartDate":{
            "title":"Step Start Date",
            "type":"string",
            "description":"The date and time when the step execution starts.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "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
        },
        "OrchestrationNumber":{
            "title":"Orchestration Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration object.",
            "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":false,
            "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"
            }
        },
        "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
        },
        "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
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : opportunities-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 of the steps in the orchestration administrator runtime UIs.
• 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 objectives.
• 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 object.
• OrchestrationStepId: integer (int64)
  Read Only: true

  The unique identifier of the orchestration step 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

  Suggestion text of the Orchestration step.
• StepType: string
  Read Only: true

  Maximum Length: 30

  The type of step.

{
    "type":"object",
    "properties":{
        "OrchestrationAssocId":{
            "type":"integer",
            "description":"The unique identifier of the orchestration association.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DisplaySequence":{
            "type":"integer",
            "description":"The order of the steps in the orchestration administrator runtime UIs.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "StepType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of step.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ContainMultipleTasks":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the step contains multiple tasks.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStepId":{
            "type":"integer",
            "description":"The unique identifier of the orchestration step object.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "StepEndDate":{
            "type":"string",
            "description":"Specifies the date and time when the step execution ends.",
            "format":"date-time",
            "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"
            }
        },
        "OrchestrationStepName":{
            "maxLength":"100",
            "type":"string",
            "description":"The name of orchestration step.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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 objectives.",
            "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
        },
        "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
        },
        "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 object.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StepSuggestionText":{
            "maxLength":"2000",
            "type":"string",
            "description":"Suggestion text of the Orchestration step.",
            "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 : 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 : opportunities-OrchestrationAssociations-StepTransitions-item-response

Type: object

Show Source

• ActivityAppointmentStatusCode: string
  Title: Appointment Status

  Read Only: true

  Maximum Length: 30

  Denotes the status of the Appointment.
• ActivityDescription: string (byte)
  Title: Description

  Read Only: true

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

  Read Only: true

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

  Read Only: true

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

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

  Read Only: true

  Maximum Length: 64

  Alternate identifier of the activity. System generated or can come from external system (user key).
• ActivityOwnerId: integer (int64)
  Title: Owner ID

  Read Only: true

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

  Read Only: true

  Maximum Length: 360

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

  Read Only: true

  Maximum Length: 4000

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

  Read Only: true

  Maximum Length: 4000

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

  Read Only: true

  Smart action identifier. Foriegn key from zca_user_action.
• ActivityStartDate: string (date-time)
  Title: Start Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 500

  Subject or name ot title of the activity.
• ActivityTaskStatusCode: string
  Title: Status

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

  Maximum Length: 2000

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

  Read Only: true

  Maximum Length: 1

  Default Value: true

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

  Maximum Length: 2000

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

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date when the record was created.
• EmailType: string
  Title: Email Type

  Maximum Length: 30

  The orchestration step transition runtime email type.
• ExitOrchestrationFlag: boolean
  Title: Exit Orchestration

  Read Only: true

  Maximum Length: 1

  Indicates whether or not to exit the orchestration when stop step occurs.
• InboundConvMsgId: integer (int64)
  Title: Inbound Conversation Message ID

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

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

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

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

  Read Only: true

  Maximum Length: 64

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

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

  Read Only: true

  Maximum Length: 100

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

  Read Only: true

  Maximum Length: 64

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

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

  Read Only: true

  Maximum Length: 100

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

  Read Only: true

  Maximum Length: 64

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

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

  Read Only: true

  Maximum Length: 100

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

  Read Only: true

  Maximum Length: 64

  The alternate identifier of the orchestration step object.
• OrchestrationStepTasksId: integer (int64)
  Title: Orchestration Step Tasks ID

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

  Read Only: true

  Maximum Length: 30

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

  Maximum Length: 1

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

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

  Maximum Length: 1

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 2000

  Suggestion text of the Orchestration step.
• StepTaskDisplaySequence: integer (int32)
  Title: Display Sequence

  Read Only: true

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

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

  Maximum Length: 64

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

  Maximum Length: 30

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

  Maximum Length: 1

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

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

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

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

  Maximum Length: 30

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

  The unique identifier of the wrap up.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailType":{
            "title":"Email Type",
            "maxLength":"30",
            "type":"string",
            "description":"The orchestration step transition runtime email type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrchestrationAssociationNumber":{
            "title":"Orchestration Association Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration association.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStepNumber":{
            "title":"Orchestration Step Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration step object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivityOwnerPartyName":{
            "title":"Owner",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the party.",
            "nullable":false,
            "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
        },
        "ActivityNumber":{
            "title":"Activity Number",
            "maxLength":"64",
            "type":"string",
            "description":"Alternate identifier of the activity. System generated or can come from external system (user key).",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ExitOrchestrationFlag":{
            "title":"Exit Orchestration",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether or not to exit the orchestration when stop step occurs.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ActivitySMARTActionId":{
            "title":"Smart Action ID",
            "type":"integer",
            "description":"Smart action identifier. Foriegn key from zca_user_action.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ActivityTaskStatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"Status of the activity. Defaulted to NOT_STARTED.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "InteractionId":{
            "title":"Interaction ID",
            "type":"integer",
            "description":"The unique identifier of interaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TransitionEndDateTime":{
            "title":"Transition End Date Time",
            "type":"string",
            "description":"The date and time when the step transition ended.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationNumber":{
            "title":"Orchestration Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration object.",
            "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
        },
        "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
        },
        "StepSuggestionText":{
            "title":"Step Suggestion Text",
            "maxLength":"2000",
            "type":"string",
            "description":"Suggestion text of the Orchestration step.",
            "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
        },
        "OrchestrationStepType":{
            "title":"Step Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of step.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "StepTransitionNumber":{
            "title":"Step Transition Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration step transition object.",
            "nullable":false,
            "x-queryable":true
        },
        "ConversationId":{
            "title":"Conversation ID",
            "type":"integer",
            "description":"The unique identifier of conversation message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "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 datetime for a task.",
            "format":"date-time",
            "nullable":true,
            "readOnly":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,
            "x-queryable":true
        },
        "ActivityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"The unique identifier of the activity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "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
        },
        "OrchestrationStageName":{
            "title":"Stage Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the orchestration stage object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TransitionDueDateTime":{
            "title":"Transition Due Date Time",
            "type":"string",
            "description":"The date and time when the step transition is due.",
            "format":"date-time",
            "nullable":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"
            }
        },
        "TransitionStartDateTime":{
            "title":"Transition Start Date Time",
            "type":"string",
            "description":"The date and time 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
        },
        "AllowSkipFlag":{
            "title":"Allow Step Skipping",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether or not to show skip or thumbs down icon in guidance primary or secondary banner.",
            "nullable":true,
            "readOnly":true,
            "default":true,
            "x-queryable":false
        },
        "RefreshPageFlag":{
            "title":"Refresh Page",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether or not to refresh the whole page before surfacing the current Step in the runtime UI.",
            "nullable":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"
            }
        },
        "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"
            }
        },
        "OrchestrationStageNumber":{
            "title":"Orchestration Stage Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate identifier of the orchestration stage object.",
            "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
        },
        "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
        },
        "OrchestrationName":{
            "title":"Orchestration Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of orchestration object.",
            "nullable":false,
            "readOnly":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
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrchestrationStepId":{
            "title":"Orchestration Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration step object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActivitySMARTActionContext":{
            "title":"Smart Action Context",
            "maxLength":"4000",
            "type":"string",
            "description":"Stores metadata needed for smart action",
            "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
        },
        "OrchestrationStepName":{
            "title":"Orchestration Step Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of orchestration step.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivitySubject":{
            "title":"Subject",
            "maxLength":"500",
            "type":"string",
            "description":"Subject or name ot title of the activity.",
            "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
        },
        "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"
            }
        },
        "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
        },
        "ActivityAppointmentStatusCode":{
            "title":"Appointment Status",
            "maxLength":"30",
            "type":"string",
            "description":"Denotes the status of the Appointment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Links

AssociationStatusCodeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_ORCH_ASSOC_RT_STATUS

The list of values indicating the runtime status of the orchestration object association.

ErrorLogs

Operation: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/ErrorLogs

Parameters:

• OptyNumber: $request.path.OptyNumber
• OrchestrationAssociationNumber: $request.path.OrchestrationAssociationNumber

The error logs resource is used to view error logs associated to the orchestration associations.

PerformActionVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_ORCH_RT_PERFORM_ACTION

The list of values indicating the actions that users can perform on this orchestration step.

StageObjectives

Operation: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/StageObjectives

Parameters:

• OptyNumber: $request.path.OptyNumber
• OrchestrationAssociationNumber: $request.path.OrchestrationAssociationNumber

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

Stages

Operation: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/Stages

Parameters:

• OptyNumber: $request.path.OptyNumber
• OrchestrationAssociationNumber: $request.path.OrchestrationAssociationNumber

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

StepTransitions

Operation: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/StepTransitions

Parameters:

• OptyNumber: $request.path.OptyNumber
• OrchestrationAssociationNumber: $request.path.OrchestrationAssociationNumber

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

Steps

Operation: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/Steps

Parameters:

• OptyNumber: $request.path.OptyNumber
• OrchestrationAssociationNumber: $request.path.OrchestrationAssociationNumber

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

StepsInExecutionPath

Operation: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/StepsInExecutionPath

Parameters:

• OptyNumber: $request.path.OptyNumber
• OrchestrationAssociationNumber: $request.path.OrchestrationAssociationNumber

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

Back to Top